geokit 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a65b885be9e9d49c301e1c027f0b67ed5b6c0cf5
-  data.tar.gz: 0a3f1ef269758d9647be947192d2137bc9239503
+  metadata.gz: 45cd130b831e467dddf0f1ee196ad1a9c454709d
+  data.tar.gz: abc3aae596ba4407b204936be4f5af7b7cc07ff6
 SHA512:
-  metadata.gz: 4435c54ff2edb3ba749b2d8a2d5ed3a8a45fab5e22df8d3e1fd8a2da39a9ae30e6054f0c8f1a012d9dfe7cfd5677b02f9650234d3af708067766727a7e9dc94d
-  data.tar.gz: b87976064a7e40f5d65e9fe7dc4afa36677449d390b41f3f63ed403b99c8404e4e6599700e12a956175f5e35db599d15a443456448864b1efd12dadcbc16e499
+  metadata.gz: f38b92f2a28271fe715528a4508af36f388b7303f54f1fd9423e939e36771912dadbbe84b88ff40a5a69f20596b9e14e12bd95bb1479cc450636c583796b6d0b
+  data.tar.gz: 6713c52093f575b38576a426586447f4b921d5df80f53f277145d82de36e8e1ad7f126bfdadf328d5772f4cbb450988036701753f9e69796ecd392376cb58e57

data/.rubocop.yml

@@ -214,7 +214,7 @@ Style/Lambda:
 
 # Offense count: 4
 # Cop supports --auto-correct.
-Style/MethodCallParentheses:
+Style/MethodCallWithoutArgsParentheses:
   Exclude:
     - 'test/test_maxmind_geocoder.rb'
 

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.12.0
+
+**Existing Geocoder Changes**
+* FreegeoIp: Deprecated
+
+**Other Changes**
+* Added Ipstack which replaces Freegeoip
+
 ## 1.11.0
 
 **Existing Geocoder Changes**

data/README.markdown

@@ -62,7 +62,9 @@ Combine this gem with the [geokit-rails](http://github.com/geokit/geokit-rails)
 * Geobytes
 * RIPE
 * MaxMind
-* freegeoip.net
+* Ipstack
+* freegeoip.net (deprecated, now Ipstack)
+* IP-API.com
 
 ### HTTPS-supporting geocoders
 * Google
@@ -169,6 +171,11 @@ If you're using this gem by itself, here are the configuration options:
     # See http://www.geonames.org
     Geokit::Geocoders::GeonamesGeocoder.key = 'KEY'
 
+    # This is your access key for ipstack.
+    # To use this service either free or premium, you must register a key.
+    # See https://ipstack.com
+    Geokit::Geocoders::IpstackGeocoder.api_key = 'API_KEY'
+
     # Most other geocoders need either no setup or a key
     Geokit::Geocoders::BingGeocoder.key = ''
     Geokit::Geocoders::MapQuestGeocoder.key = ''
@@ -187,13 +194,19 @@ If you're using this gem by itself, here are the configuration options:
 
     # This is the order in which the geocoders are called in a failover scenario
     # If you only want to use a single geocoder, put a single symbol in the array.
-    # Valid symbols are :google, :yahoo, :us, and :ca.
+    #
+    # Valid symbols are: :bing, :ca, :fcc, :geocodio, :geonames, :google,
+    # :map_quest, :mapbox, :maxmind, :opencage, :osm, :us, :yahoo, and :yandex.
+    #
     # Be aware that there are Terms of Use restrictions on how you can use the
     # various geocoders.  Make sure you read up on relevant Terms of Use for each
     # geocoder you are going to use.
     Geokit::Geocoders::provider_order = [:google,:us]
 
-    # The IP provider order. Valid symbols are :ip,:geo_plugin.
+    # The IP provider order.
+    #
+    # Valid symbols are :ipstack, :geo_plugin, :geobytes, :ip, and :ripe.
+    #
     # As before, make sure you read up on relevant Terms of Use for each.
     # Geokit::Geocoders::ip_provider_order = [:external,:geo_plugin,:ip]
 

data/fixtures/vcr_cassettes/ip_api_geocode.yml

@@ -0,0 +1,35 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://ip-api.com/json/74.125.237.209
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - "*"
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Sat, 23 Sep 2017 04:40:17 GMT
+      Content-Length:
+      - '287'
+    body:
+      encoding: UTF-8
+      string: '{"as":"AS15169 Google Inc.","city":"Mountain View","country":"United
+        States","countryCode":"US","isp":"Google","lat":37.4192,"lon":-122.0574,"org":"Google","query":"74.125.237.209","region":"CA","regionName":"California","status":"success","timezone":"America/Los_Angeles","zip":"94043"}'
+    http_version: 
+  recorded_at: Sat, 23 Sep 2017 04:34:33 GMT
+recorded_with: VCR 3.0.3

data/fixtures/vcr_cassettes/ipstack_geocode.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.ipstack.com/68.194.36.44?access_key=some_api_key
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 08 May 2018 13:21:13 GMT
+      Content-Type:
+      - application/json; Charset=UTF-8
+      Transfer-Encoding:
+      - chunked
+      X-Apilayer-Transaction-Id:
+      - 595071a3-1531-41eb-8697-1143f21a78cb
+      Access-Control-Allow-Origin:
+      - "*"
+      X-Request-Time:
+      - '0.026'
+    body:
+      encoding: UTF-8
+      string: '{"ip":"68.194.36.44","type":"ipv4","continent_code":"NA","continent_name":"North
+        America","country_code":"US","country_name":"United States","region_code":"NY","region_name":"New
+        York","city":"The Bronx","zip":"10466","latitude":40.8913,"longitude":-73.8448,"location":{"geoname_id":5110266,"capital":"Washington
+        D.C.","languages":[{"code":"en","name":"English","native":"English"}],"country_flag":"http:\/\/assets.ipstack.com\/flags\/us.svg","country_flag_emoji":"\ud83c\uddfa\ud83c\uddf8","country_flag_emoji_unicode":"U+1F1FA
+        U+1F1F8","calling_code":"1","is_eu":false}}'
+    http_version: 
+  recorded_at: Tue, 08 May 2018 13:21:13 GMT
+recorded_with: VCR 4.0.0

data/lib/geokit/geocoders.rb

@@ -26,6 +26,7 @@ module Geokit
   # ### IP address geocoders
   # * IP Geocoder - geocodes an IP address using hostip.info's web service.
   # * Geoplugin.net -- another IP address geocoder
+  # * IP-API.com -- another IP address geocoder
   #
   # ### The Multigeocoder
   # * Multi Geocoder - provides failover for the physical location geocoders.
@@ -39,6 +40,7 @@ module Geokit
     @@ip_provider_order = [:geo_plugin, :ip]
     @@logger = Logger.new(STDOUT)
     @@logger.level = Logger::INFO
+    @@host = nil
     @@domain = nil
     @@net_adapter = Geokit::NetAdapter::NetHttp
     @@secure = true

data/lib/geokit/geocoders/free_geo_ip.rb

@@ -5,6 +5,10 @@ module Geokit
       private
 
       def self.do_geocode(ip, _=nil)
+        warn '[DEPRECATION] `freegeoip` is deprecated. Please use `ipstack`'\
+             ' instead. You can find more at'\
+             ' https://github.com/apilayer/freegeoip#readme'
+
         process :xml, ip
       end
 

data/lib/geokit/geocoders/google.rb

@@ -1,7 +1,7 @@
 module Geokit
   module Geocoders
     class GoogleGeocoder < Geocoder
-      config :client_id, :cryptographic_key, :channel, :api_key
+      config :client_id, :cryptographic_key, :channel, :api_key, :host
       self.secure = true
 
       private
@@ -89,7 +89,8 @@ module Geokit
           url_with_key = query_string + "&key=#{api_key}"
           "#{protocol}://maps.googleapis.com" + url_with_key
         else
-          "#{protocol}://maps.google.com" + query_string
+          request_host = host || 'maps.google.com'
+          "#{protocol}://#{request_host}#{query_string}"
         end
       end
 

data/lib/geokit/geocoders/ip_api_geocoder.rb

@@ -0,0 +1,31 @@
+module Geokit
+  module Geocoders
+    # Provides geocoding based upon an IP address.  The underlying web service is ip-api.com
+    class IpApiGeocoder < BaseIpGeocoder
+      private
+
+      def self.do_geocode(ip, _=nil)
+        process :json, ip
+      end
+
+      def self.submit_url(ip)
+        "http://ip-api.com/json/#{ip}"
+      end
+
+      def self.parse_json(result)
+        loc = new_loc
+        return loc unless result['status'] == 'success'
+
+        loc.success = true
+        loc.city = result['city']
+        loc.state = result['region']
+        loc.state_name = result['regionName']
+        loc.zip = result['zip']
+        loc.lat = result['lat']
+        loc.lng = result['lon']
+        loc.country_code = result['countryCode']
+        loc
+      end
+    end
+  end
+end

data/lib/geokit/geocoders/ipstack.rb

@@ -0,0 +1,36 @@
+module Geokit
+  module Geocoders
+    # Provides geocoding based upon an IP address. The underlying web service is
+    # ipstack, old freegeoip.net
+    class IpstackGeocoder < BaseIpGeocoder
+      config :api_key
+
+      private
+
+      def self.do_geocode(ip, _options = nil)
+        process :json, ip
+      end
+
+      def self.submit_url(ip)
+        "http://api.ipstack.com/#{ip}?access_key=#{api_key}"
+      end
+
+      def self.parse_json(result)
+        loc = new_loc
+        return loc if result['success'] == false
+
+        loc.city = result['city']
+        loc.state_code = result['region_code']
+        loc.state_name = result['region_name']
+        loc.zip = result['zip']
+        loc.lat = result['latitude']
+        loc.lng = result['longitude']
+        loc.country_code = result['country_code']
+        loc.country = result['country_name']
+        loc.success = !loc.city.nil?
+
+        loc
+      end
+    end
+  end
+end

data/lib/geokit/lat_lng.rb

@@ -118,7 +118,7 @@ module Geokit
     end
 
     def self.from_string(thing)
-      thing.strip!
+      thing = thing.strip
       match = thing.match(/(\-?\d+\.?\d*)[, ] ?(\-?\d+\.?\d*)$/)
       if match
         Geokit::LatLng.new(match[1], match[2])

data/lib/geokit/version.rb

@@ -1,3 +1,3 @@
 module Geokit
-  VERSION = '1.11.0'
+  VERSION = '1.12.0'
 end

data/test/test_google_geocoder.rb

@@ -50,6 +50,19 @@ class GoogleGeocoderTest < BaseGeocoderTest #:nodoc: all
     assert_equal 'http://maps.google.com/maps/api/geocode/json?sensor=false&address=New+York', url
   end
 
+  def test_google_cn
+    Geokit::Geocoders.host = 'maps.google.cn'
+    url = "#{@base_url}?sensor=false&address=#{escape(@address)}"
+    TestHelper.expects(:last_url).with(url)
+    res = geocode(@address, :google_full_short)
+    assert_equal 'CA', res.state
+    assert_equal 'San Francisco', res.city
+    assert_array_in_delta [37.7749295, -122.4194155], res.to_a # slightly dif from yahoo
+    assert res.is_us?
+    assert_equal 'San Francisco, CA, USA', res.full_address # slightly different from yahoo
+    assert_equal 'google', res.provider
+  end
+
   def test_google_full_address
     url = "#{@base_url}?sensor=false&address=#{escape(@address)}"
     TestHelper.expects(:last_url).with(url)

data/test/test_ip_api_geocoder.rb

@@ -0,0 +1,23 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class IpApiGeocoderTest < BaseGeocoderTest #:nodoc: all
+  def setup
+    super
+    @ip = '74.125.237.209'
+  end
+
+  def assert_url(expected_url)
+    assert_equal expected_url, TestHelper.last_url
+  end
+
+  def test_free_geo_ip_geocode
+    url = "http://ip-api.com/json/#{@ip}"
+    res = geocode(@ip, :ip_api_geocode)
+    assert_url url
+    assert_equal res.city, 'Mountain View'
+    assert_equal res.state, 'CA'
+    assert_equal res.state_name, 'California'
+    assert_equal res.zip, '94043'
+    assert_equal res.country_code, 'US'
+  end
+end

data/test/test_ipstack_geocoder.rb

@@ -0,0 +1,27 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class IpstackGeocoderTest < BaseGeocoderTest #:nodoc: all
+  def setup
+    super
+    @ip = '68.194.36.44'
+    geocoder_class.api_key = 'some_api_key'
+  end
+
+  def assert_url(expected_url)
+    assert_equal expected_url, TestHelper.last_url
+  end
+
+  def test_free_geo_ip_geocode
+    url = "http://api.ipstack.com/#{@ip}?access_key=some_api_key"
+    res = geocode(@ip, :ipstack_geocode)
+
+    assert_url url
+    assert_equal res.city, 'The Bronx'
+    assert_equal res.state, 'NY'
+    assert_equal res.state_name, 'New York'
+    assert_equal res.zip, '10466'
+    assert_equal res.country_code, 'US'
+    assert_equal res.country, 'United States'
+    assert_equal res.success?, true
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geokit
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Michael Noack
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-26 00:00:00.000000000 Z
+date: 2018-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -226,6 +226,8 @@ files:
 - fixtures/vcr_cassettes/google_reverse_madrid.yml
 - fixtures/vcr_cassettes/google_reverse_madrid_es.yml
 - fixtures/vcr_cassettes/google_sublocality.yml
+- fixtures/vcr_cassettes/ip_api_geocode.yml
+- fixtures/vcr_cassettes/ipstack_geocode.yml
 - fixtures/vcr_cassettes/map_quest_full.yml
 - fixtures/vcr_cassettes/map_quest_reverse_madrid.yml
 - fixtures/vcr_cassettes/mapbox_forward_geocode.yml
@@ -263,6 +265,8 @@ files:
 - lib/geokit/geocoders/geonames.rb
 - lib/geokit/geocoders/google.rb
 - lib/geokit/geocoders/ip.rb
+- lib/geokit/geocoders/ip_api_geocoder.rb
+- lib/geokit/geocoders/ipstack.rb
 - lib/geokit/geocoders/mapbox.rb
 - lib/geokit/geocoders/mapquest.rb
 - lib/geokit/geocoders/maxmind.rb
@@ -295,7 +299,9 @@ files:
 - test/test_geonames_geocoder.rb
 - test/test_google_geocoder.rb
 - test/test_inflector.rb
+- test/test_ip_api_geocoder.rb
 - test/test_ipgeocoder.rb
+- test/test_ipstack_geocoder.rb
 - test/test_latlng.rb
 - test/test_map_quest.rb
 - test/test_mapbox_geocoder.rb
@@ -335,7 +341,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: 'Geokit: encoding and distance calculation gem'
@@ -355,7 +361,9 @@ test_files:
 - test/test_geonames_geocoder.rb
 - test/test_google_geocoder.rb
 - test/test_inflector.rb
+- test/test_ip_api_geocoder.rb
 - test/test_ipgeocoder.rb
+- test/test_ipstack_geocoder.rb
 - test/test_latlng.rb
 - test/test_map_quest.rb
 - test/test_mapbox_geocoder.rb