simple_geolocator 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 162ba0a2fb8e881b8bf09679250b3afdf4f4d13b
-  data.tar.gz: b18874e63807a865eb41283fad44cce504c2980a
+  metadata.gz: e4320a2241c0f8a819468d1c3bce0598bf06b213
+  data.tar.gz: d04523c554576740b5bbe41f119854ae14f481ff
 SHA512:
-  metadata.gz: 2a68ab25452b990e7be28a1cb7bae870d370922e43eab33391a677c3e3750ce1ca41f569aa506efd269985e5e18b6de01eb855e93a60376b27f61861d57102fb
-  data.tar.gz: dba071b5f272ef33cfcf928fa8003afc7773bb037a44444be9b1860faef8791fee119c343533216c56a4bd4b7183852266a06c1ce24f8711263ca5bbc8141763
+  metadata.gz: 8d2edd8a1dbe039a589cb27a90d51df0f8b2561cf889773d25b1870184f965cf1a7a90409bf8c50a45c55c017871e6c8f89e4a8fd0452d62a5ab3d99f3d0e2d2
+  data.tar.gz: 072109c812ebd0430317c98f941ab7e3c07883d4dca2d1bdc9581c60104a7593755ae91f6f956b8e716f747c8945f5d7548054fcf735adc28d37c3cd771d014b

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 ## Version 1
+### Version 1.2.0
+* Implement a simple cache that will prevent you ever exceeding the request quota! (vladc)
+* New method connection for getting the types of connection you have (proxy and/or mobile) (vladc)
+
 ### Version 1.1.0
 * Fix error method causing NoMethodError.
 * Better documentation for all methods, including adding the missing documentation for the private error method.
@@ -7,7 +11,7 @@
 * 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.
+* HTTPClient dependency is no longer open-ended.
 
 ### 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

@@ -5,16 +5,18 @@ module SimpleGeolocator
   extend self
 
   @client = HTTPClient.new
+  @cache = {}
 
   # Gets the full JSON response, useful for getting multiple pieces of data in
   #   a single request.
   # @param ip [String] The IP to get data for.
   # @return [JSON] A parsed JSON object containing the response.
   def get_full_response(ip)
-    url = "http://ip-api.com/json/#{ip}"
+    return @cache[ip] unless @cache[ip].nil?
+    url = "http://ip-api.com/json/#{ip}?fields=258047"
     uri = URI.parse(url)
     response = @client.get(uri)
-    JSON.parse(response.body)
+    @cache[ip] = JSON.parse(response.body)
   end
 
   # Gets whether the request failed or not.
@@ -136,6 +138,23 @@ module SimpleGeolocator
     response['org']
   end
 
+  # Gets the IP connection attributes - if it's a mobile and/or a proxy
+  #   connection.
+  # @param ip [String] See #get_full_response
+  # @return [Hash] A hash containing data formatted as
+  #   { :mobile => true, :proxy => true}
+  # @return [String] A string containing the error message.
+  def connection(ip)
+    response = get_full_response(ip)
+    err = error(response)
+    return err unless err.nil?
+    ret = {
+      mobile: response['mobile'],
+      proxy: response['proxy']
+    }
+    ret
+  end
+
   # Gets the according description for the semi-ambiguous error returned by the
   #   API.
   # @param error [String] The error message returned by #error

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_geolocator
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Eli Foster