simple_geolocator 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 735ce151f51274d7b644bbdb54cd11e56a42877e
-  data.tar.gz: 4e6f837aa611e4c49cd00d2565830b1e7c631cb7
+  metadata.gz: 162ba0a2fb8e881b8bf09679250b3afdf4f4d13b
+  data.tar.gz: b18874e63807a865eb41283fad44cce504c2980a
 SHA512:
-  metadata.gz: 440b2b06c50c04d14550c6e424e54eaf4db98d38a61259dd8e7c745920536f78fc7e693b6e5820e3744c06d6e54f7fb12704a8cc2e3fdc113f45f60112fa8698
-  data.tar.gz: b1bf2d26356ea53703dac86fe7334d436905aeb9433b350f0aba1123b3274ed526ec4e497622cd4f1cc88a24f318bdbcf78f0ab3656be7ed85fa0b4c5f748e03
+  metadata.gz: 2a68ab25452b990e7be28a1cb7bae870d370922e43eab33391a677c3e3750ce1ca41f569aa506efd269985e5e18b6de01eb855e93a60376b27f61861d57102fb
+  data.tar.gz: dba071b5f272ef33cfcf928fa8003afc7773bb037a44444be9b1860faef8791fee119c343533216c56a4bd4b7183852266a06c1ce24f8711263ca5bbc8141763

data/CHANGELOG.md

@@ -1,4 +1,13 @@
 # Changelog
 ## Version 1
+### Version 1.1.0
+* Fix error method causing NoMethodError.
+* Better documentation for all methods, including adding the missing documentation for the private error method.
+* Case/When statement instead of if conditional in request_successful?
+* Better code in all the getter methods, improving how values are returned and how error is called.
+* New get_error_description for getting the description to go with the ambiguous error message.
+* Better error code, which is now dependent on request_successful?, instead of having getter methods being dependent on request_successful?. This greatly reduces the length of the methods.
+* HTTPClient dependency is no longer open-eneded.
+
 ### Version 1.0.0
 * Initial release version. Contains methods for most everything available with IP-API.com. The only API that I am not utilizing is the DNS API. That should come in a future release.

data/lib/simple_geolocator.rb

@@ -3,6 +3,7 @@ require 'json'
 
 module SimpleGeolocator
   extend self
+
   @client = HTTPClient.new
 
   # Gets the full JSON response, useful for getting multiple pieces of data in
@@ -13,18 +14,19 @@ module SimpleGeolocator
     url = "http://ip-api.com/json/#{ip}"
     uri = URI.parse(url)
     response = @client.get(uri)
-    return JSON.parse(response.body)
+    JSON.parse(response.body)
   end
 
   # Gets whether the request failed or not.
-  # @param response [String] The response body (gotten by #get_full_response)
-  #   to check.
+  # @param response [JSON] The parsed response body (#get_full_response) to
+  #   check.
   # @return [Boolean] True if successful, false if errored.
   def request_successful?(response)
-    if response['status'] == 'success'
-      return true
-    else
-      return false
+    case response['status']
+    when 'success'
+      true
+    when 'fail'
+      false
     end
   end
 
@@ -32,115 +34,136 @@ module SimpleGeolocator
   # @param ip [String] See #get_full_response
   # @return [Hash] A hash containing data formatted as
   #   { :name => 'United States', :code => 'US' }
+  # @return [String] A string containing the error message.
   def country(ip)
     response = get_full_response(ip)
-    if request_successful?(response)
-      ret = {
-        :name => response['country'],
-        :code => response['countryCode']
-      }
-      return ret
-    else
-      return error(response)
-    end
+    err = error(response)
+    return err unless err.nil?
+    ret = {
+      name: response['country'],
+      code: response['countryCode']
+    }
+    ret
   end
 
   # Gets the region data for the IP.
   # @param ip [String] See #get_full_response
   # @return [Hash] A hash containing data formatted as
   #   { :name => 'Oregon', :code => 'OR'}
+  # @return [String] A string containing the error message.
   def region(ip)
     response = get_full_response(ip)
-    if request_successful?(response)
-      ret = {
-        :name => response['regionName'],
-        :code => response['region']
-      }
-      return ret
-    else
-      return error(response)
-    end
+    err = error(response)
+    return err unless err.nil?
+    ret = {
+      name: response['regionName'],
+      code: response['region']
+    }
+    ret
   end
 
   # Gets the city name for the IP.
   # @param ip [String] See #get_full_response
   # @return [String] The name of the city that the IP is located in.
+  # @return [String] A string containing the error message.
   def city(ip)
     response = get_full_response(ip)
-    if request_successful?(response)
-      return response['city']
-    else
-      return error(response)
-    end
+    err = error(response)
+    return err unless err.nil?
+
+    response['city']
   end
 
   # Gets the zip code for the IP.
   # @param ip [String] See #get_full_response
   # @return [Int] The zip code that the IP is located in.
+  # @return [String] A string containing the error message.
   def zip(ip)
     response = get_full_response(ip)
-    if request_successful?(response)
-      return response['zip'].to_i
-    else
-      return error(response)
-    end
+    err = error(response)
+    return err unless err.nil?
+
+    response['zip'].to_i
   end
 
   # Gets the latitude, longitude for the IP.
   # @param ip [String] See #get_full_response
   # @return [Array] An array of Floats formatted as lat, lon
+  # @return [String] A string containing the error message.
   def ll(ip)
     response = get_full_response(ip)
-    if request_successful?(response)
-      ret = [
-        response['lat'],
-        response['lon']
-      ]
-      return ret
-    else
-      return error(response)
-    end
+    err = error(response)
+    return err unless err.nil?
+
+    ret = [response['lat'], response['lon']]
+    ret
   end
 
   # Gets the timezone for the IP.
   # @param ip [String] See #get_full_response
   # @return [String] The timezone (UTC, PST, etc.) that the IP is in.
+  # @return [String] A string containing the error message.
   def timezone(ip)
     response = get_full_response(ip)
-    if request_successful?(response)
-      return response['timezone']
-    else
-      return error(response)
-    end
+    err = error(response)
+    return err unless err.nil?
+
+    response['timezone']
   end
 
   # Gets the name of the IP's Internet Service Provider.
   # @param ip [String] See #get_full_response
   # @return [String] The ISP name, such as Comcast Cable.
+  # @return [String] A string containing the error message.
   def isp_name(ip)
     response = get_full_response(ip)
-    if request_successful?(response)
-      return response['isp']
-    else
-      return error(response)
-    end
+    err = error(response)
+    return err unless err.nil?
+
+    response['isp']
   end
 
   # Gets the name of the IP's organization. For most people, this is identical
   #   to their ISP name.
   # @param ip [String] See #get_full_response
   # @return [String] The organization name, such as Google.
+  # @return [String] A string containing the error message.
   def organization_name(ip)
     response = get_full_response(ip)
-    if request_successful?(response)
-      return response['org']
+    err = error(response)
+    return err unless err.nil?
+
+    response['org']
+  end
+
+  # Gets the according description for the semi-ambiguous error returned by the
+  #   API.
+  # @param error [String] The error message returned by #error
+  # @return [String] The error description.
+  # @return [Nil] If you provided an invalid error message.
+  def get_error_description(error)
+    case error
+    when 'private range'
+      return 'The IP address is part of a private range.'
+    when 'reserved range'
+      return 'The IP address is part of a reserved range.'
+    when 'invalid query'
+      return 'The IP address or domain name is invalid.'
+    when 'quota'
+      return 'You have reached the quota.'
     else
-      return error(response)
+      return nil
     end
   end
 
   private
+
+  # Gets the error message from a response.
+  # @param response [JSON] See #request_successful?
+  # @return [String] The error message.
+  # @return [Nil] If there was no error message to begin with.
   def error(response)
-    return response['message']
+    return response['message'] unless request_successful?(response)
+    nil
   end
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: simple_geolocator
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Eli Foster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-21 00:00:00.000000000 Z
+date: 2015-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.6.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.6.0.1
 description: Accessing the IP API through HTTPClient. I found that many, if not all,
   Geolocation gems were very annoying and overly-complex to use. Thus, this gem was
   born. It does not use anything like Google or Yahoo! Geolocation because I have