simple_geolocator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 735ce151f51274d7b644bbdb54cd11e56a42877e
+  data.tar.gz: 4e6f837aa611e4c49cd00d2565830b1e7c631cb7
+SHA512:
+  metadata.gz: 440b2b06c50c04d14550c6e424e54eaf4db98d38a61259dd8e7c745920536f78fc7e693b6e5820e3744c06d6e54f7fb12704a8cc2e3fdc113f45f60112fa8698
+  data.tar.gz: b1bf2d26356ea53703dac86fe7334d436905aeb9433b350f0aba1123b3274ed526ec4e497622cd4f1cc88a24f318bdbcf78f0ab3656be7ed85fa0b4c5f748e03

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+## Version 1
+### 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

@@ -0,0 +1,146 @@
+require 'httpclient'
+require 'json'
+
+module SimpleGeolocator
+  extend self
+  @client = HTTPClient.new
+
+  # 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}"
+    uri = URI.parse(url)
+    response = @client.get(uri)
+    return 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.
+  # @return [Boolean] True if successful, false if errored.
+  def request_successful?(response)
+    if response['status'] == 'success'
+      return true
+    else
+      return 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' }
+  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
+  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'}
+  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
+  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.
+  def city(ip)
+    response = get_full_response(ip)
+    if request_successful?(response)
+      return response['city']
+    else
+      return error(response)
+    end
+  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.
+  def zip(ip)
+    response = get_full_response(ip)
+    if request_successful?(response)
+      return response['zip'].to_i
+    else
+      return error(response)
+    end
+  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
+  def ll(ip)
+    response = get_full_response(ip)
+    if request_successful?(response)
+      ret = [
+        response['lat'],
+        response['lon']
+      ]
+      return ret
+    else
+      return error(response)
+    end
+  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.
+  def timezone(ip)
+    response = get_full_response(ip)
+    if request_successful?(response)
+      return response['timezone']
+    else
+      return error(response)
+    end
+  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.
+  def isp_name(ip)
+    response = get_full_response(ip)
+    if request_successful?(response)
+      return response['isp']
+    else
+      return error(response)
+    end
+  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.
+  def organization_name(ip)
+    response = get_full_response(ip)
+    if request_successful?(response)
+      return response['org']
+    else
+      return error(response)
+    end
+  end
+
+  private
+  def error(response)
+    return response['message']
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: simple_geolocator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Eli Foster
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+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.
+email: elifosterwy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- lib/simple_geolocator.rb
+homepage: https://github.com/elifoster/simple_geolocator
+licenses:
+- CC-BY-NC-ND-4.0
+metadata:
+  issue_tracker: https://github.com/elifoster/simple_geolocator/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A Ruby gem for easily using the IP-API.com API to perform IP geolocation.
+test_files: []