IPinfo 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a8df58dc0d3caeada335bcd3a46e35ea5d533a3c47d8226817441d0395a0513a
+  data.tar.gz: 4cb9dd3927bbe7e7a88cc918cd08306705042cbf7971ba83bf33d0ad3f7d84fd
+SHA512:
+  metadata.gz: f892448f0a5fa74f86de90763f9abeccbe97fccc12213e4aca94cc53f735ad1295b171f79cf94f259253ad782fdbf5b643c9dba082a35ebd5fc38d746647b699
+  data.tar.gz: bef7befefa3fffc171fbf443847e40f8a49b93ff9c5f712deed8ca8d2e28708250a28e4e44f78a08302bc93f60809d45e5d34265d6f6975b117074a8e814a57e

data/.editorconfig

@@ -0,0 +1,13 @@
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+# Two spaces for indenting
+[*]
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+max_line_length = 120

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,13 @@
+sudo: false
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+
+before_install:
+- gem install bundler

data/Gemfile

@@ -0,0 +1,34 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ipinfo.gemspec
+gemspec
+
+
+group :development do
+  # Rack 2.0+ requires Ruby >= 2.2.2 which is problematic for the test suite on
+  # older Ruby versions. Check Ruby the version here and put a maximum
+  # constraint on Rack if necessary.
+
+  if RUBY_VERSION >= "2.2.2"
+    gem "rack", ">= 1.5"
+  else
+    gem "rack", ">= 1.5", "< 2.0"
+  end
+
+  gem "bundler"
+  gem "rake"
+  gem "minitest"
+  gem 'minitest-vcr'
+  gem 'minitest-reporters'
+  gem 'webmock'
+
+  platforms :mri do
+    # to avoid problems, bring Byebug in on just versions of Ruby under which
+    # it's known to work well
+    if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new("2.0.0")
+      gem "byebug"
+      gem "pry"
+      gem "pry-byebug"
+    end
+  end
+end

data/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "[]"
+replaced with your own identifying information. (Don't include
+the brackets!)  The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,194 @@
+# [<img src="https://ipinfo.io/static/ipinfo-small.svg" alt="IPinfo" width="24"/>](https://ipinfo.io/) IPinfo Ruby Client Library
+
+This is the official Ruby client library for the [IPinfo.io](https://ipinfo.io) IP address API, allowing you to lookup your own IP address, or get any of the following details for an IP:
+ - IP geolocation (city, region, country, postal code, latitude and longitude)
+ - ASN details (ISP or network operator, associated domain name, and type, such as business, hosting or company)
+ - Company details (the name and domain of the business that uses the IP address)
+ - Carrier details (the name of the mobile carrier and MNC and MCC for that carrier if the IP is used exclusively for mobile traffic)
+
+
+### Getting Started
+
+You'll need an IPinfo API access token, which you can get by singing up for a free account at [https://ipinfo.io/signup](https://ipinfo.io/signup?ref=lib-Ruby).
+
+The free plan is limited to 1,000 requests a day, and doesn't include some of the data fields such as IP type and company data. To enable all the data fields and additional request volumes see [https://ipinfo.io/pricing](https://ipinfo.io/pricing?ref=lib-Ruby)
+
+#### Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ipinfo'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ipinfo
+
+#### Quick Start
+
+```ruby
+require 'ipinfo'
+
+access_token = '123456789abc'
+handler = IPinfo::create(access_token)
+ip_address = '216.239.36.21'
+
+details = handler.details(ip_address)
+city = details.city # Emeryville
+loc = details.loc # 37.8342,-122.2900
+```
+
+#### Usage
+
+The `IPinfo.details()` method accepts an IP address as an optional, positional argument. If no IP address is specified, the API will return data for the IP address from which it receives the request.
+
+```ruby
+require 'ipinfo'
+
+access_token = '123456789abc'
+handler = IPinfo::create(access_token)
+
+details = handler.details()
+city = details.city # "Emeryville"
+loc = details.loc # 37.8342,-122.2900
+```
+
+#### Authentication
+
+The IPinfo library can be authenticated with your IPinfo API token, which is passed in as a positional argument. It also works without an authentication token, but in a more limited capacity.
+
+```ruby
+access_token = '123456789abc'
+handler = IPinfo::create(access_token)
+```
+
+#### Details Data
+
+`handler.details()` will return a `Response` object that contains all fields listed in the [IPinfo developer docs](https://ipinfo.io/developers/responses#full-response) with a few minor additions. Properties can be accessed directly.
+
+```ruby
+hostname = details.hostname # cpe-104-175-221-247.socal.res.rr.com
+```
+
+##### Country Name
+
+`details.country_name` will return the country name, as supplied by the `countries.json` file. See below for instructions on changing that file for use with non-English languages. `details.country` will still return country code.
+
+```ruby
+country = details.country # US
+country_name = details.country_name # United States
+```
+
+#### IP Address
+
+`details.ip_address` will return the an `IPAddr` object from the [Ruby Standard Library](https://ruby-doc.org/stdlib-2.5.1/libdoc/ipaddr/rdoc/IPAddr.html). `details.ip` will still return a string.
+
+```ruby
+ip = details.ip # 104.175.221.247
+ip_addr = details.ip_address # <IPAddr: IPv4:104.175.221.247/255.255.255.255>
+```
+
+##### Longitude and Latitude
+
+`details.latitude` and `details.longitude` will return latitude and longitude, respectively, as strings. `details.loc` will still return a composite string of both values.
+
+```ruby
+loc = details.loc # 34.0293,-118.3570
+lat = details.latitude # 34.0293
+lon = details.longitude # -118.3570
+```
+
+##### Accessing all properties
+
+`details.all` will return all details data as a dictionary.
+
+```ruby
+details.all = {
+:asn => {  :asn => 'AS20001',
+           :domain => 'twcable.com',
+           :name => 'Time Warner Cable Internet LLC',
+           :route => '104.172.0.0/14',
+           :type => 'isp'},
+:city => 'Los Angeles',
+:company => {  :domain => 'twcable.com',
+               :name => 'Time Warner Cable Internet LLC',
+               :type => 'isp'},
+:country => 'US',
+:country_name => 'United States',
+:hostname => 'cpe-104-175-221-247.socal.res.rr.com',
+:ip => '104.175.221.247',
+:ip_address => <IPAddr: IPv4:104.175.221.247/255.255.255.255>,
+:loc => '34.0293,-118.3570',
+:latitude => '34.0293',
+:longitude => '-118.3570',
+:phone => '323',
+:postal => '90016',
+:region => 'California'
+}
+```
+
+#### Caching
+
+In-memory caching of `details` data is provided by default via the [lrucache](https://www.rubydoc.info/gems/lrucache/0.1.4/LRUCache) gem. This uses an LRU (least recently used) cache with a TTL (time to live) by default. This means that values will be cached for the specified duration; if the cache's max size is reached, cache values will be invalidated as necessary, starting with the oldest cached value.
+
+##### Modifying cache options
+
+Cache behavior can be modified by setting the `cache_options` keyword argument. `cache_options` is a dictionary in which the keys are keyword arguments specified in the `cachetools` library. The nesting of keyword arguments is to prevent name collisions between this library and its dependencies.
+
+* Default maximum cache size: 4096 (multiples of 2 are recommended to increase efficiency)
+* Default TTL: 24 hours (in seconds)
+
+```ruby
+token = '1234'
+handler = IPinfo::create(token, {:ttl => 30, :maxsize => 30})
+```
+
+##### Using a different cache
+
+It's possible to use a custom cache by creating a child class of the [CacheInterface](https://github.com/jhtimmins/ruby/blob/master/lib/ipinfo/cache/cache_interface.rb) class and passing this into the handler object with the `cache` keyword argument. FYI this is known as [the Strategy Pattern](https://sourcemaking.com/design_patterns/strategy).
+
+```ruby
+handler = IPinfo.handler(token, {:cache => my_fancy_custom_class})
+```
+
+
+### Using a different HTTP library
+Ruby is notorious for having lots of HTTP libraries. While `Net::HTTP` is a reasonable default, you can set any other that [Faraday supports](https://github.com/lostisland/faraday/tree/29feeb92e3413d38ffc1fd3a3479bb48a0915730#faraday) if you prefer.
+
+```ruby
+access_token = '123456789abc'
+handler = IPinfo::create(access_token, {:http_client => my_client})
+```
+
+Don't forget to bundle the custom HTTP library as well.
+
+#### Internationalization
+
+When looking up an IP address, the response object includes a `details.country_name` attribute which includes the country name based on American English. It is possible to return the country name in other languages by setting the `countries` setting when creating the `IPinfo` object.
+
+The file must be a `.json` file with the following structure:
+
+```
+{
+ "BD": "Bangladesh",
+ "BE": "Belgium",
+ "BF": "Burkina Faso",
+ "BG": "Bulgaria"
+ ...
+}
+```
+
+### Other Libraries
+
+There are official IPinfo client libraries available for many languages including PHP, Go, Java, Ruby, and many popular frameworks such as Django, Rails and Laravel. There are also many third party libraries and integrations available for our API.
+
+### About IPinfo
+
+Founded in 2013, IPinfo prides itself on being the most reliable, accurate, and in-depth source of IP address data available anywhere. We process terabytes of data to produce our custom IP geolocation, company, carrier and IP type data sets. Our API handles over 12 billion requests a month for 100,000 businesses and developers.
+
+[![image](https://avatars3.githubusercontent.com/u/15721521?s=128&u=7bb7dde5c4991335fb234e68a30971944abc6bf3&v=4)](https://ipinfo.io/)

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ipinfo"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ipinfo.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ipinfo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "IPinfo"
+  spec.version       = IPinfo::VERSION
+  spec.required_ruby_version = ">= 2.0.0"
+  spec.authors       = ["Stanislav K, James Timmins"]
+  spec.email         = ["jameshtimmins@gmail.com"]
+
+  spec.summary       = %q{ This is a ruby wrapper for http://ipinfo.io. }
+  spec.description   = %q{ This is a ruby wrapper for http://ipinfo.io. }
+  spec.homepage      = "https://ipinfo.io"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    #spec.metadata['allowed_push_host'] = "http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.add_runtime_dependency 'faraday', '~> 0'
+  spec.add_runtime_dependency 'lrucache', '~> 0.1.4'
+  spec.add_runtime_dependency 'json', '~> 2.1'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/ipinfo.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'cgi'
+require 'ipaddr'
+require 'ipinfo/adapter'
+require 'ipinfo/cache/default_cache'
+require 'ipinfo/errors'
+require 'ipinfo/response'
+require 'ipinfo/version'
+require 'json'
+
+module IPinfo
+  DEFAULT_CACHE_MAXSIZE = 4096
+  DEFAULT_CACHE_TTL = 60 * 60 * 24
+  DEFAULT_COUNTRY_FILE = File.join(File.dirname(__FILE__), 'ipinfo/countries.json')
+  RATE_LIMIT_MESSAGE = "To increase your limits, please review our paid plans at https://ipinfo.io/pricing"
+
+  class << self
+    def create(access_token=nil, settings={})
+      IPinfo.new(access_token, settings)
+    end
+  end
+
+  class IPinfo
+    attr_accessor :access_token
+    attr_accessor :countries
+    attr_accessor :http_client
+
+    def initialize(access_token=nil, settings={})
+      @access_token = access_token
+      @http_client = http_client(settings.fetch("http_client", nil))
+
+      maxsize = settings.fetch("maxsize", DEFAULT_CACHE_MAXSIZE)
+      ttl = settings.fetch("ttl", DEFAULT_CACHE_TTL)
+      @cache = settings.fetch("cache", DefaultCache.new(ttl, maxsize))
+      @countries = countries(settings.fetch('countries', DEFAULT_COUNTRY_FILE))
+    end
+
+    def details(ip_address=nil)
+      details = request_details(ip_address)
+      if details.has_key? :country
+        details[:country_name] = @countries.fetch(details.fetch(:country), nil)
+      end
+
+      if details.has_key? :ip
+        details[:ip_address] = IPAddr.new(details.fetch(:ip))
+      end
+
+      if details.has_key? :loc
+        loc = details.fetch(:loc).split(",")
+        details[:latitude] = loc[0]
+        details[:longitude] = loc[1]
+      end
+
+      Response.new(details)
+    end
+
+    protected
+    def request_details(ip_address=nil)
+      if !@cache.contains?(ip_address)
+        response = @http_client.get(escape_path(ip_address))
+
+        raise RateLimitError.new(RATE_LIMIT_MESSAGE) if response.status.eql?(429)
+
+        details = JSON.parse(response.body, symbolize_names: true)
+        @cache.set(ip_address, details)
+      end
+      @cache.get(ip_address)
+    end
+
+    def http_client(http_client=nil)
+      if http_client
+        @http_client = Adapter.new(access_token, http_client)
+      else
+        @http_client = Adapter.new(access_token)
+      end
+    end
+
+    def countries(filename)
+      file = File.read(filename)
+      JSON.parse(file)
+    end
+
+    private
+    def escape_path(ip)
+      ip ? "/#{CGI::escape(ip)}" : '/'
+    end
+  end
+end

data/lib/ipinfo/adapter.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+require 'faraday'
+require 'cgi'
+
+module IPinfo
+  class Adapter
+    HOST = 'ipinfo.io'
+
+    attr_reader :conn
+
+    def initialize(token = nil, adapter = :net_http)
+      @token = token
+      @conn = connection(adapter)
+    end
+
+    def get(uri)
+      @conn.get(uri) do |req|
+        default_headers.each_pair do |key, value|
+          req.headers[key] = value
+        end
+        req.params['token'] = CGI::escape(token) if token
+      end
+    end
+
+    private
+
+    attr_reader :token
+
+    def connection(adapter)
+      Faraday.new(url: "https://#{HOST}") do |faraday|
+        faraday.adapter adapter
+      end
+    end
+
+    def default_headers
+        headers = {
+          'User-Agent' => "IPinfoClient/Ruby/1.0",
+          'Accept' => 'application/json'
+        }
+        if token
+          headers['Authorization'] = "Bearer #{CGI::escape(token)}"
+        end
+        headers
+    end
+  end
+end

data/lib/ipinfo/cache/cache_interface.rb

@@ -0,0 +1,16 @@
+module IPinfo
+  class CacheInterface
+    class InterfaceNotImplemented < StandardError; end
+    def get(key)
+      raise InterfaceNotImplemented
+    end
+
+    def set(key, value)
+      raise InterfaceNotImplemented
+    end
+
+    def contains?(key)
+      raise InterfaceNotImplemented
+    end
+  end
+end

data/lib/ipinfo/cache/default_cache.rb

@@ -0,0 +1,23 @@
+require 'ipinfo/cache/cache_interface'
+require 'lrucache'
+
+module IPinfo
+  class DefaultCache < CacheInterface
+
+    def initialize(ttl, max_size)
+      @cache = LRUCache.new(:ttl => ttl, :max_size => max_size)
+    end
+
+    def get(key)
+      @cache[key]
+    end
+
+    def set(key, value)
+      @cache[key] = value
+    end
+
+    def contains?(key)
+      !@cache[key].nil?
+    end
+  end
+end

data/lib/ipinfo/countries.json

@@ -0,0 +1 @@
+{"BD": "Bangladesh", "BE": "Belgium", "BF": "Burkina Faso", "BG": "Bulgaria", "BA": "Bosnia and Herzegovina", "BB": "Barbados", "WF": "Wallis and Futuna", "BL": "Saint Barthelemy", "BM": "Bermuda", "BN": "Brunei", "BO": "Bolivia", "BH": "Bahrain", "BI": "Burundi", "BJ": "Benin", "BT": "Bhutan", "JM": "Jamaica", "BV": "Bouvet Island", "BW": "Botswana", "WS": "Samoa", "BQ": "Bonaire, Saint Eustatius and Saba ", "BR": "Brazil", "BS": "Bahamas", "JE": "Jersey", "BY": "Belarus", "BZ": "Belize", "RU": "Russia", "RW": "Rwanda", "RS": "Serbia", "TL": "East Timor", "RE": "Reunion", "TM": "Turkmenistan", "TJ": "Tajikistan", "RO": "Romania", "TK": "Tokelau", "GW": "Guinea-Bissau", "GU": "Guam", "GT": "Guatemala", "GS": "South Georgia and the South Sandwich Islands", "GR": "Greece", "GQ": "Equatorial Guinea", "GP": "Guadeloupe", "JP": "Japan", "GY": "Guyana", "GG": "Guernsey", "GF": "French Guiana", "GE": "Georgia", "GD": "Grenada", "GB": "United Kingdom", "GA": "Gabon", "SV": "El Salvador", "GN": "Guinea", "GM": "Gambia", "GL": "Greenland", "GI": "Gibraltar", "GH": "Ghana", "OM": "Oman", "TN": "Tunisia", "JO": "Jordan", "HR": "Croatia", "HT": "Haiti", "HU": "Hungary", "HK": "Hong Kong", "HN": "Honduras", "HM": "Heard Island and McDonald Islands", "VE": "Venezuela", "PR": "Puerto Rico", "PS": "Palestinian Territory", "PW": "Palau", "PT": "Portugal", "SJ": "Svalbard and Jan Mayen", "PY": "Paraguay", "IQ": "Iraq", "PA": "Panama", "PF": "French Polynesia", "PG": "Papua New Guinea", "PE": "Peru", "PK": "Pakistan", "PH": "Philippines", "PN": "Pitcairn", "PL": "Poland", "PM": "Saint Pierre and Miquelon", "ZM": "Zambia", "EH": "Western Sahara", "EE": "Estonia", "EG": "Egypt", "ZA": "South Africa", "EC": "Ecuador", "IT": "Italy", "VN": "Vietnam", "SB": "Solomon Islands", "ET": "Ethiopia", "SO": "Somalia", "ZW": "Zimbabwe", "SA": "Saudi Arabia", "ES": "Spain", "ER": "Eritrea", "ME": "Montenegro", "MD": "Moldova", "MG": "Madagascar", "MF": "Saint Martin", "MA": "Morocco", "MC": "Monaco", "UZ": "Uzbekistan", "MM": "Myanmar", "ML": "Mali", "MO": "Macao", "MN": "Mongolia", "MH": "Marshall Islands", "MK": "Macedonia", "MU": "Mauritius", "MT": "Malta", "MW": "Malawi", "MV": "Maldives", "MQ": "Martinique", "MP": "Northern Mariana Islands", "MS": "Montserrat", "MR": "Mauritania", "IM": "Isle of Man", "UG": "Uganda", "TZ": "Tanzania", "MY": "Malaysia", "MX": "Mexico", "IL": "Israel", "FR": "France", "IO": "British Indian Ocean Territory", "SH": "Saint Helena", "FI": "Finland", "FJ": "Fiji", "FK": "Falkland Islands", "FM": "Micronesia", "FO": "Faroe Islands", "NI": "Nicaragua", "NL": "Netherlands", "NO": "Norway", "NA": "Namibia", "VU": "Vanuatu", "NC": "New Caledonia", "NE": "Niger", "NF": "Norfolk Island", "NG": "Nigeria", "NZ": "New Zealand", "NP": "Nepal", "NR": "Nauru", "NU": "Niue", "CK": "Cook Islands", "XK": "Kosovo", "CI": "Ivory Coast", "CH": "Switzerland", "CO": "Colombia", "CN": "China", "CM": "Cameroon", "CL": "Chile", "CC": "Cocos Islands", "CA": "Canada", "CG": "Republic of the Congo", "CF": "Central African Republic", "CD": "Democratic Republic of the Congo", "CZ": "Czech Republic", "CY": "Cyprus", "CX": "Christmas Island", "CR": "Costa Rica", "CW": "Curacao", "CV": "Cape Verde", "CU": "Cuba", "SZ": "Swaziland", "SY": "Syria", "SX": "Sint Maarten", "KG": "Kyrgyzstan", "KE": "Kenya", "SS": "South Sudan", "SR": "Suriname", "KI": "Kiribati", "KH": "Cambodia", "KN": "Saint Kitts and Nevis", "KM": "Comoros", "ST": "Sao Tome and Principe", "SK": "Slovakia", "KR": "South Korea", "SI": "Slovenia", "KP": "North Korea", "KW": "Kuwait", "SN": "Senegal", "SM": "San Marino", "SL": "Sierra Leone", "SC": "Seychelles", "KZ": "Kazakhstan", "KY": "Cayman Islands", "SG": "Singapore", "SE": "Sweden", "SD": "Sudan", "DO": "Dominican Republic", "DM": "Dominica", "DJ": "Djibouti", "DK": "Denmark", "VG": "British Virgin Islands", "DE": "Germany", "YE": "Yemen", "DZ": "Algeria", "US": "United States", "UY": "Uruguay", "YT": "Mayotte", "UM": "United States Minor Outlying Islands", "LB": "Lebanon", "LC": "Saint Lucia", "LA": "Laos", "TV": "Tuvalu", "TW": "Taiwan", "TT": "Trinidad and Tobago", "TR": "Turkey", "LK": "Sri Lanka", "LI": "Liechtenstein", "LV": "Latvia", "TO": "Tonga", "LT": "Lithuania", "LU": "Luxembourg", "LR": "Liberia", "LS": "Lesotho", "TH": "Thailand", "TF": "French Southern Territories", "TG": "Togo", "TD": "Chad", "TC": "Turks and Caicos Islands", "LY": "Libya", "VA": "Vatican", "VC": "Saint Vincent and the Grenadines", "AE": "United Arab Emirates", "AD": "Andorra", "AG": "Antigua and Barbuda", "AF": "Afghanistan", "AI": "Anguilla", "VI": "U.S. Virgin Islands", "IS": "Iceland", "IR": "Iran", "AM": "Armenia", "AL": "Albania", "AO": "Angola", "AQ": "Antarctica", "AS": "American Samoa", "AR": "Argentina", "AU": "Australia", "AT": "Austria", "AW": "Aruba", "IN": "India", "AX": "Aland Islands", "AZ": "Azerbaijan", "IE": "Ireland", "ID": "Indonesia", "UA": "Ukraine", "QA": "Qatar", "MZ": "Mozambique"}

data/lib/ipinfo/errors.rb

@@ -0,0 +1,3 @@
+module IPinfo
+  class RateLimitError < StandardError; end
+end

data/lib/ipinfo/response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'ipaddr'
+require 'json'
+
+module IPinfo
+  class Response
+
+    attr_reader :all
+
+    def initialize(response)
+      @all = response
+
+      @all.each do |name, value|
+        instance_variable_set("@#{name}", value)
+        self.class.send(:attr_accessor, name)
+      end
+    end
+  end
+end

data/lib/ipinfo/version.rb

@@ -0,0 +1,3 @@
+module IPinfo
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: IPinfo
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Stanislav K, James Timmins
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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'
+- !ruby/object:Gem::Dependency
+  name: lrucache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: " This is a ruby wrapper for http://ipinfo.io. "
+email:
+- jameshtimmins@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ipinfo.gemspec
+- lib/ipinfo.rb
+- lib/ipinfo/adapter.rb
+- lib/ipinfo/cache/cache_interface.rb
+- lib/ipinfo/cache/default_cache.rb
+- lib/ipinfo/countries.json
+- lib/ipinfo/errors.rb
+- lib/ipinfo/response.rb
+- lib/ipinfo/version.rb
+homepage: https://ipinfo.io
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+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: This is a ruby wrapper for http://ipinfo.io.
+test_files: []