Removing geocoder.us. Changing api_key to key for IP-API, similar to …

…other geocoders.
wyattisimo · Feb 2, 2023 · f91a537 · f91a537
1 parent 8c921fd
commit f91a537
Show file tree

Hide file tree

Showing 7 changed files with 11 additions and 108 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 1.15.0
+
+* Removed support for no longer accessible geocoder.us
+
 ## 1.14.0
 
 * Introduced NoSuchGeocoderError. If you try call a geocoder like :bogus that doesn't exist, an error will be returned.

diff --git a/README.markdown b/README.markdown
@@ -59,7 +59,6 @@ Combine this gem with the [geokit-rails](http://github.com/geokit/geokit-rails)
 ### IP address geocoders
 * IP - geocodes an IP address using hostip.info's web service.
 * Geoplugin.net -- another IP address geocoder
-* Geobytes
 * RIPE
 * MaxMind
 * Ipstack
@@ -150,13 +149,6 @@ If you're using this gem by itself, here are the configuration options:
     # You define these keys with a Hash as follows:
     #Geokit::Geocoders::google = { 'rubyonrails.org' => 'RUBY_ON_RAILS_API_KEY', 'ruby-docs.org' => 'RUBY_DOCS_API_KEY' }
 
-    # This is your username and password for geocoder.us.
-    # To use the free service, the value can be set to nil or false.  For
-    # usage tied to an account, the value should be set to username:password.
-    # See http://geocoder.us
-    # and http://geocoder.us/user/signup
-    Geokit::Geocoders::UsGeocoder.key = 'username:password'
-
     # This is your authorization key for geocoder.ca.
     # To use the free service, the value can be set to nil or false.  For
     # usage tied to an account, set the value to the key obtained from
@@ -177,9 +169,8 @@ If you're using this gem by itself, here are the configuration options:
 
     # This is your api key for ip-api.com.
     # For the free version (with rate limits), leave api_key unset.
-    # For the pro version, api_key must be set
     # See https://ip-api.com/
-    Geokit::Geocoders::IpApiGeocoder.api_key = 'API_KEY'
+    Geokit::Geocoders::IpApiGeocoder.key = ''
 
     # Most other geocoders need either no setup or a key
     Geokit::Geocoders::BingGeocoder.key = ''
@@ -210,7 +201,7 @@ If you're using this gem by itself, here are the configuration options:
 
     # The IP provider order.
     #
-    # Valid symbols are :ipstack, :geo_plugin, :geobytes, :ip, and :ripe.
+    # Valid symbols are :ipstack, :geo_plugin, :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]

diff --git a/lib/geokit/geocoders/ip_api_geocoder.rb b/lib/geokit/geocoders/ip_api_geocoder.rb
@@ -2,7 +2,7 @@ module Geokit
   module Geocoders
     # Provides geocoding based upon an IP address.  The underlying web service is ip-api.com
     class IpApiGeocoder < BaseIpGeocoder
-      config :api_key
+      config :key
 
       private
 
@@ -11,10 +11,10 @@ def self.do_geocode(ip, _=nil)
       end
 
       def self.submit_url(ip)
-        if api_key.nil?
+        if key.nil?
           "http://ip-api.com/json/#{ip}"
         else
-          "http://pro.ip-api.com/json/#{ip}?key=#{api_key}"
+          "http://pro.ip-api.com/json/#{ip}?key=#{key}"
         end
       end
 

diff --git a/lib/geokit/geocoders/us_geocoder.rb b/lib/geokit/geocoders/us_geocoder.rb
diff --git a/lib/geokit/version.rb b/lib/geokit/version.rb
@@ -1,3 +1,3 @@
 module Geokit
-  VERSION = '1.14.0'
+  VERSION = '1.15.0'
 end
diff --git a/test/test_ip_api_geocoder.rb b/test/test_ip_api_geocoder.rb
@@ -22,7 +22,7 @@ def test_ip_api_geocode
   end
 
   def test_ip_api_pro_geocode
-    geocoder_class.api_key = 'some_api_key'
+    geocoder_class.key = 'some_api_key'
     url = "http://pro.ip-api.com/json/#{@ip}?key=some_api_key"
     res = geocode(@ip, :ip_api_pro_geocode)
     assert_url url

diff --git a/test/test_us_geocoder.rb b/test/test_us_geocoder.rb