ip_to_earth 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 881975620b315dd19ec558c791daf4bf28b1ef844b0bef6dc6fcf55d9b41db87
+  data.tar.gz: 37494f862b4768f38790f67398ace65cbbdde69f2bcead5e8ec84b38ec4b1719
+SHA512:
+  metadata.gz: d6026b34e21431fedee9c75bee945387c07121c686ed22aa0e31fef212f4f94d1685f173ae7313cc3cc4a8425290eeafcc6ea8ca031da7c8c0b2bec5be3c8ace
+  data.tar.gz: 02ca79cd2d32860e75560454583a1f3fa7d99ad35c567d7f252cd4ae264baf9408cc4c3a0ebac1eda551d5b1af93f86a09e054d20be806771c83aa63df84338d

data/README.md

@@ -0,0 +1,140 @@
+
+<p align="center">
+  <img src="https://app.expeditedaddons.com/iptoearth.png"/>
+  
+</p>
+
+<h1 align='center'>IP to Earth</h1>
+
+## Find the Country and City of origin for an IP Address
+
+## Requirements
+
+- An API Key from Heroku
+    - Add from: https://elements.heroku.com/addons/iptoearth
+
+- Ruby v2.x or greater
+
+## Usage
+
+### Input Parameter Descriptions
+
+| Index       | Name    | Example | Description |
+| --------------- | ------- | -------- |--------|
+|0|`ip`|string|IPv4 or IPv6 address|
+
+
+
+### Making a Request
+
+```ruby
+require "ip_to_earth"
+
+IpToEarth.lookup('68.10.149.45') # Pass in any valid IPv4 or IPv6 value
+```
+
+### Using Results
+
+```ruby
+result = IpToEarth.lookup("8.8.8.8")
+# => #<struct IpToEarth::APIResult
+#  valid=true,
+#  country="United States",
+#  country_code="US",
+#  hostname="",
+#  city="Mountain View",
+#  ip="8.8.8.8",
+#  latitude=37.40599060058594,
+#  longitude=-122.0785140991211,
+#  region="California",
+#  continent_code="NA",
+#  country_code3="USA",
+#  currency_code="USD">
+
+result.valid # => true 
+result.country # => "United States" 
+result.country_code # => "US" 
+result.city # => "Virginia Beach" 
+result.latitude # => 37.40599060058594 
+# ...
+```
+
+
+## Installation
+
+```ruby
+# In your Gemfile
+gem 'ip_to_earth', git: 'https://github.com/LynxEyes/ip_to_earth.git'
+```    
+
+
+## Result Attribute Descriptions
+
+| Attribute       | Type    | Description |
+| --------------- | ------- | -------- |
+|`valid`|boolean|If the IP Address passed in is syntactically valid|
+|`country`|string|Full country name where the IP address is located|
+|`country_code`|string|ISO Country Code for the IP Address|
+|`hostname`|string|Hostname - if any - for the IP address|
+|`city`|string|City where the IP Address is located|
+|`ip`|string|IP address that was evaluated|
+|`latitude`|float|Geographic latitude of the identified IP address|
+|`longitude`|float|Geographic longitude of the identified IP address|
+|`region`|string|State or Region where the IP address is located|
+
+
+## Live Interactive Testing
+
+Doublecheck results, use a Live Proxy and check your API Key with the interactive documentation at:
+
+http://docs.iptoearthexp.apiary.io/
+
+You will need your `IPTOEARTH_API_KEY` from the setup screen where you've provisioned the IP to Earth add-on.
+
+## Troubleshooting
+
+As a sanity check it is sometimes useful to bypass your app stack and check the endpoint, your API Key and parameters directly.
+
+*Test with your browser*
+
+```
+# Modify the following to use your actual API Key
+'https://iptoearth.expeditedaddons.com/?api_key=REPLACE_WITH_YOUR_IPTOEARTH_API_KEY&ip=68.10.149.45'
+```
+
+A successful call will return your requested data with a HTTP result code of `200` and be in `JSON` format. We recommend the [JSON Formatter](https://chrome.google.com/webstore/detail/json-formatter/bcjindcccaagfpapjjmafapmmgkkhgoa?hl=en) extension as a useful tool. 
+
+## In Development
+
+The IP to Earth gem relies upon the environment variable `ENV['IPTOEARTH_API_KEY']` being present and correctly configured to authenticate to the service. You will need to have this variable present in your local environment for the gem to work correctly.
+
+If you're using Heroku, please read their [Guide to Heroku Local](https://devcenter.heroku.com/articles/heroku-local) which has instructions on easily copying your config values to your development environment.
+
+**DOTENV**
+
+[https://github.com/bkeepers/dotenv](https://github.com/bkeepers/dotenv)
+
+If you're trying to use IP to Earth in your local development or test environment with the [dotenv](https://github.com/bkeepers/dotenv) gem be sure that you are loading the `dotenv-rails` gem with the `rails-now` requirement. 
+
+```ruby
+# Example Gemfile excerpt
+
+gem 'dotenv-rails', :require => 'dotenv/rails-now'
+gem 'iptoearth'
+```
+
+**FOREMAN**
+
+[https://github.com/ddollar/foreman](https://github.com/ddollar/foreman)
+
+If you're having issues with configuring `dotenv`, you might want to try [foreman](https://github.com/ddollar/foreman) which will also autoload `.env` files in your local environment.
+
+
+**Test in the Rails console**
+
+Launch `rails c` in your development project directory and at the prompt enter `ENV[IPTOEARTH_API_KEY]` which, if you've configured your development environment correctly should display your API Key.
+
+## License
+
+The IP to Earth gem is licensed under the MIT license.
+

data/lib/ip_to_earth/api_controller.rb

@@ -0,0 +1,45 @@
+module IpToEarth
+  class APIController
+    HEADERS = {
+      accept: 'application/json'
+    }.freeze
+
+    def initialize(api_key: Configuration.api_key)
+      @lookup_url_template =
+        Addressable::Template.new("#{Configuration.base_uri}/{?ip,api_key}")
+                             .partial_expand(api_key: api_key)
+    end
+
+    def lookup(ip)
+      query_url = lookup_url_template.expand(ip: ip)
+
+      response = Http.headers(HEADERS).get(query_url)
+
+      fail_on_bad_response(response)
+      parse_response(response)
+    end
+
+    private
+
+    attr_reader :lookup_url_template
+
+    def fail_on_bad_response(response)
+      return unless [403, 404, 429, 500].include?(response.code)
+
+      error_message = case response.code
+                      when 429 then "Rate limit exceeded"
+                      when 404 then "Endpoint not found"
+                      when 500 then "Endpoint application error"
+                      when 403 then "API Key not found or invalid"
+                      end
+
+      raise APIException.new(error_message, response.code, response.body)
+    end
+
+    def parse_response(response)
+      APIResult.new(response.parse(:json))
+    rescue JSON::ParserError
+      raise APIException.new("Invalid JSON returned.", response.code, response.to_s)
+    end
+  end
+end

data/lib/ip_to_earth/api_exception.rb

@@ -0,0 +1,11 @@
+module IpToEarth
+  class APIException < StandardError
+    attr_reader :response_code, :response_body
+
+    def initialize(reason, response_code, response_body)
+      super(reason)
+      @response_code = response_code
+      @response_body = response_body
+    end
+  end
+end

data/lib/ip_to_earth/api_result.rb

@@ -0,0 +1,11 @@
+module IpToEarth
+  APIResult = Struct.new(:valid, :country, :country_code, :hostname,
+                         :city, :ip, :latitude, :longitude, :region,
+                         :continent_code, :country_code3, :currency_code) do
+
+    # NOTE: yes, keyword_init: true exists but raises an error on unknown keywords!
+    def initialize(args)
+      members.each { |field| send("#{field}=", args[field.to_s]) }
+    end
+  end
+end

data/lib/ip_to_earth/client.rb

@@ -0,0 +1,15 @@
+module IpToEarth
+  class Client
+    def self.default
+      @default_instance ||= new
+    end
+
+    def initialize(api_key: Configuration.api_key)
+      @api_controller = APIController.new(api_key: api_key)
+    end
+
+    def lookup(ip)
+      @api_controller.lookup(ip)
+    end
+  end
+end

data/lib/ip_to_earth/configuration.rb

@@ -0,0 +1,11 @@
+module IpToEarth
+  class Configuration
+    @base_uri = "https://iptoearth.expeditedaddons.com" || ENV['IPTOEARTH_URI']
+
+    @api_key = ENV['IPTOEARTH_API_KEY']
+
+    class << self
+      attr_reader :base_uri, :api_key
+    end
+  end
+end

data/lib/ip_to_earth.rb

@@ -0,0 +1,20 @@
+require 'openssl'
+require 'json'
+require 'http'
+require 'addressable'
+
+require_relative 'ip_to_earth/api_exception.rb'
+require_relative 'ip_to_earth/configuration.rb'
+require_relative 'ip_to_earth/client.rb'
+require_relative 'ip_to_earth/api_controller.rb'
+require_relative 'ip_to_earth/api_result.rb'
+
+module IpToEarth
+  def self.lookup(ip)
+    Client.default.lookup(ip)
+  end
+
+  def self.with_api_key(key)
+    Client.new(api_key: key)
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: ip_to_earth
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Ivo Jesus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Find the Country and City of origin for an IP Address
+email: ivo.jesus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/ip_to_earth.rb
+- lib/ip_to_earth/api_controller.rb
+- lib/ip_to_earth/api_exception.rb
+- lib/ip_to_earth/api_result.rb
+- lib/ip_to_earth/client.rb
+- lib/ip_to_earth/configuration.rb
+homepage: https://github.com/LynxEyes/ip_to_earth
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: ip_to_earth
+test_files: []