simple_geolocator 1.3.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d547622e164acc542c21353ad5fff91f715e27a
-  data.tar.gz: 509c64a23b967b85aed9ba610500fb361aeaa7f5
+  metadata.gz: d34a6dd5b6ab7a2083148bfda6cea13bea50c1d4
+  data.tar.gz: 97e8790d7cae108624fbdf427f4c0ff5003bbb56
 SHA512:
-  metadata.gz: 7295ff74aace198794a8717274d28eec932e6c679f7e3ffdc4d5dc9e9aa12adf3f8dc4da021391f8cc251deaf183e73c8fdd853cb1de33f91372f160f35f390e
-  data.tar.gz: 9295764ea999981303a66498fb7dedbd38001c184d86dd6af88b85753895fd0a667adf47e10db92d7e088622b4524ce755bb22ecb2394432b793bb02abe139b0
+  metadata.gz: db40c6977128f87c0413d473a5547a1c6e8bdf5af73b728284553e580a27458b2217e3e65283cea0c183d40470e98292cc5c76e563a4ee3004b345dd389f4469
+  data.tar.gz: 6d91d3dcf14e9b96517e0aec6a62cec24a959911c044d87f20abb23dcded0e1f052f0ae1843cb2a74addffe120c9c4d5272fed06402c11a269dbe14f938196a4

data/CHANGELOG.md

@@ -1,4 +1,30 @@
 # Changelog
+## Version 2
+### Version 2.0.0
+* Complete rewrite of the gem. Includes the following changes:
+  * SimpleGeolocator is no longer a helper module containing methods for every type of data. Now, you call the 
+  `SimpleGeolocator#get` function, which returns an IPAPIResponse object. This object has instance attributes to 
+  replace almost all of the old SimpleGeolocator module functions. The exception to this is connection, which has 
+  been replaced by the `IPAPIResponse#mobile?` and `IPAPIResponse#proxy?` functions.
+  * Proper error handling has been introduced. Functions will no longer return error strings. Now, 
+  `IPAPIResponse#initialize` fails with the according errors, to quickly alert the developer or user that something 
+  has gone wrong.
+  * `zip` is no longer an Integer, because that implies that some math should be done on it. It is a String now. You 
+  can call `#to_i` if you for some reason want it to be an Integer.
+  * Region (`#region`) and country (`#country`) are now represented by a LOCATION_STRUCT Struct, which has 2 instance 
+  attributes: name and code.
+  * Longitude and latitude (`#ll`) are no longer represented as an array, but a Pair from the data_types gem. This 
+  makes significantly more conceptual sense.
+  * `#isp_name` and `#organization_name` are now represented by the new named `isp` and `organization` instance 
+  attributes.
+* Changes to the libraries and requirements:
+  * HTTPClient is no longer used. It had largely too much overhead for a gem this simple. When we do not need 
+  keepalive, complicated requests, or even just a "full" client, I found it didn't make sense to use it.  Now, Curb 
+  is used.
+  * The stdlib JSON library is not used anymore. It has been replaced by Optimized JSON (Oj) for performance reasons.
+  * data_types is now a library used by SimpleGeolocator.
+  * Pessimistic version requirements are now used.
+
 ## Version 1
 ### Version 1.3.2
 * License as MIT

data/bin/simplegeo

@@ -9,30 +9,27 @@ require 'string-utility'
 require_relative '../lib/simple_geolocator'
 
 if ARGV.empty?
-  puts 'You must provide an IP.'
-  exit
+  fail 'You must provide an IP.'
 end
 
 ip = ARGV[0]
-city = SimpleGeolocator.city(ip)
-region = SimpleGeolocator.region(ip)[:name]
-country = SimpleGeolocator.country(ip)[:name]
-zip = SimpleGeolocator.zip(ip)
-ll = SimpleGeolocator.ll(ip)
-timezone = SimpleGeolocator.timezone(ip)
-isp = SimpleGeolocator.isp_name(ip)
-org = SimpleGeolocator.organization_name(ip)
-connection_attributes = SimpleGeolocator.connection(ip)
+response = SimpleGeolocator.get(ip)
+city = response.city
+region = response.region.name
+country = response.country.name
+zip = response.zip
+ll = response.ll
+timezone = response.timezone
+isp = response.isp
+org = response.organization
+mobile = response.mobile?
+proxy = response.proxy?
 
 puts "Here is the data for #{ip}:"
 puts Rainbow("ISP: #{isp}").color(StringUtility.random_color_six)
 puts Rainbow("Organization: #{org}").color(StringUtility.random_color_six)
 puts Rainbow("Timezone: #{timezone}").color(StringUtility.random_color_six)
-puts Rainbow("Location: #{city}, #{region}, #{country}, #{zip}")
-  .color(StringUtility.random_color_six)
-puts Rainbow("Exact location: #{ll[0]}, #{ll[1]}")
-  .color(StringUtility.random_color_six)
-puts Rainbow('They are using a mobile connection.')
-  .color(StringUtility.random_color_six) if connection_attributes[:mobile]
-puts Rainbow('They are using a proxy.')
-  .color(StringUtility.random_color_six) if connection_attributes[:proxy]
+puts Rainbow("Location: #{city}, #{region}, #{country}, #{zip}").color(StringUtility.random_color_six)
+puts Rainbow("Exact location: #{ll.left}, #{ll.right}").color(StringUtility.random_color_six)
+puts Rainbow('They are using a mobile connection.').color(StringUtility.random_color_six) if mobile
+puts Rainbow('They are using a proxy.').color(StringUtility.random_color_six) if proxy

data/lib/simple_geolocator/ipapi_response.rb

@@ -0,0 +1,83 @@
+# noinspection RubyTooManyInstanceVariablesInspection
+module SimpleGeolocator
+  class IPAPIResponse
+    # @return [Hash<String, Any>] The full parsed response given by the API.
+    attr_reader :full_response
+
+    # @return [LOCATION_STRUCT] The country name and code.
+    attr_reader :country
+
+    # @return [LOCATION_STRUCT] The region name and code.
+    attr_reader :region
+
+    # @return [String] The name of the city.
+    attr_reader :city
+
+    # @return [String] The zip code.
+    attr_reader :zip
+
+    # @return [Pair<Float, Float>] The pair of the longitude and latitude.
+    attr_reader :ll
+
+    # @return [String] The name of the timezone, e.g., America/Los Angeles.
+    attr_reader :timezone
+
+    # @return [String] The name of the ISP that the IP is using.
+    attr_reader :isp
+
+    # @return [String] The name of the organization that the IP is within, or their ISP name.
+    attr_reader :organization
+
+    # A simple struct that stores the name and code for the location.
+    # @param name [String] The name of the location.
+    # @param code [String] The location code.
+    LOCATION_STRUCT = Struct.new(:name, :code)
+
+    # Creates a new IPAPIResponse object.
+    # @param response [Hash] The response given by the IP API.
+    # @raise [RuntimeError] When the request fails, raises a RuntimeError depending on the error message.
+    def initialize(response = {})
+      @full_response = response
+      @status = response['status']
+      if successful?
+        @country = LOCATION_STRUCT.new(response['country'], response['countryCode'])
+        @region = LOCATION_STRUCT.new(response['regionName'], response['region'])
+        @city = response['city']
+        @zip = response['zip']
+        @ll = Pair.new(response['lat'], response['lon'])
+        @isp = response['isp']
+        @timezone = response['timezone']
+        @organization = response['org']
+        @mobile = response['mobile']
+        @proxy = response['proxy']
+      else
+        case response['message']
+        when 'private range'
+          fail 'The IP address is part of a private range.'
+        when 'reserved range'
+          fail 'The IP address is part of a reserved range.'
+        when 'invalid query'
+          fail 'The IP address or domain name is invalid.'
+        when 'quota'
+          fail 'You have reached the IP API rate limit.'
+        else
+        end
+      end
+    end
+
+    # @return [Boolean] Whether the request was successful.
+    def successful?
+      @status == 'success'
+    end
+
+    # @return [Boolean] Whether the IP is on a mobile device.
+    def mobile?
+      @mobile
+    end
+
+    # @return [Boolean] Whether the IP is on a proxy.
+    def proxy?
+      @proxy
+    end
+  end
+end

data/lib/simple_geolocator.rb

@@ -1,188 +1,24 @@
-require 'httpclient'
-require 'json'
+require 'curb'
+require 'oj'
+require 'data_types/pair'
+require_relative 'simple_geolocator/ipapi_response'
 
 module SimpleGeolocator
-  extend self
+  module_function
 
-  @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)
-    return @cache[ip] unless @cache[ip].nil?
-    url = "http://ip-api.com/json/#{ip}?fields=258047"
-    uri = URI.parse(url)
-    response = @client.get(uri)
-    @cache[ip] = JSON.parse(response.body)
-  end
-
-  # Gets whether the request failed or not.
-  # @param response [JSON] The parsed response body (#get_full_response) to
-  #   check.
-  # @return [Boolean] True if successful, false if errored.
-  def request_successful?(response)
-    case response['status']
-    when 'success'
-      true
-    when 'fail'
-      false
-    end
-  end
-
-  # Gets the country data for the IP.
-  # @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)
-    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)
-    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)
-    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)
-    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)
-    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)
-    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)
-    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)
-    err = error(response)
-    return err unless err.nil?
+  URL_FORMAT = 'http://ip-api.com/json/%s?fields=258047'.freeze
 
-    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
-  # @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 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'] unless request_successful?(response)
-    nil
+  # Gets the full response. From here, all the data related to the IP can be accessed. Caches the result in order to
+  #   prevent reaching the rate limit.
+  # @param ip [String] The IP to get data for.
+  # @return [IPAPIResponse] The full parsed response object.
+  def get(ip)
+    return @cache[ip] if @cache.key?(ip)
+    url = format(URL_FORMAT, ip)
+    response = Curl.get(url).body_str
+    ipapi = SimpleGeolocator::IPAPIResponse.new(Oj.load(response))
+    @cache[ip] = ipapi
   end
 end

metadata

@@ -1,69 +1,88 @@
 --- !ruby/object:Gem::Specification
 name: simple_geolocator
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Eli Foster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-23 00:00:00.000000000 Z
+date: 2016-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: string-utility
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: httpclient
+  name: curb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
-    - - ">="
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.0.1
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
-    - - ">="
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: data_types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        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
-  found that those APIs are unpredictable and often-times broken. This Gem has been
-  made to be as simple to use as possible. It also includes a CLI that can be called
-  simple as 'simplegeo' followed by the IP.
+        version: '1'
+description: |
+  Accessing the IP API through Curb. This gem has been made to be as simple to use as possible. As such, it even includes
+  a CLI that can be called through `simplegeo <ip>`.
 email: elifosterwy@gmail.com
 executables:
 - simplegeo
@@ -73,6 +92,7 @@ files:
 - CHANGELOG.md
 - bin/simplegeo
 - lib/simple_geolocator.rb
+- lib/simple_geolocator/ipapi_response.rb
 homepage: https://github.com/elifoster/simple_geolocator
 licenses:
 - MIT