ipinfo-rails 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7afb846da30144077a602885bacbd5ae683083c7c5cf7ef96669b87ad1953e64
-  data.tar.gz: 0cd3f7f0be43e6ea9bb5fe027efdc072d52ff23a4d2f725638014e58060f2fb4
+  metadata.gz: 48b6909038d2fd6aeba7e2ab4003e03488696606e4595e89c7b7984435ff4269
+  data.tar.gz: 35858d6386399aa7f553456d188006f1553ef1fad571aee3d590739bcca75090
 SHA512:
-  metadata.gz: d5b289c284e54ec051c93c81fd5ef4cbf0a23e83bf621730e0bc3f6cc64908b711aa70445c48d5c0fd6a5aae919f9541ed68d5546642465d45f29072d3ffd28c
-  data.tar.gz: 1a0cfd1a9379bd0c1542398f37c24a00ada8d28cb2462b70649dca1688edb5465d5886cbd4301645d9382678ed1346b0c4c278349bafe04c505e73b0170c8dd9
+  metadata.gz: 915e1bae34ebbbb5b52139bd4141e7b06b68578fcc6b03d9e71e40620c172b28b99e20f6f8713a5e40ef23e951483e67150e05cf0f298e18297812f9ac595ba9
+  data.tar.gz: 66e90173dc81ff9eee5d3a4022e40d87881a5e099699f7b24d187020d7f64f0175491259dd8e75436699be4a0c4a78ca1cbd851cb461f2545d036ae8b30899d8

data/.github/workflows/test.yml

@@ -0,0 +1,31 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ["3.2", "3.3", "3.4"]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run tests
+        run: bundle exec rake

data/.ruby-version

@@ -1 +1 @@
-2.7.2
+3.2.2

data/Gemfile

@@ -8,5 +8,6 @@ group :development do
     gem 'bundler'
     gem 'minitest'
     gem 'minitest-reporters'
+    gem 'rake'
     gem 'rubocop'
 end

data/README.md

@@ -1,9 +1,9 @@
 # <img src="https://ipinfo.io/static/ipinfo-small.svg" alt="IPinfo" width="24"/> IPinfo Rails Client Library
 
-This is the official Rails client library for the IPinfo.io IP address API, allowing you to lookup your own IP address, or get any of the following details for an IP:
+This is the official Rails client library for the IPinfo.io IP address API, allowing you to look up your own IP address, or get any of the following details for an IP:
 
-- [Geolocation](https://ipinfo.io/ip-geolocation-api) (city, region, country, postal code, latitude and longitude)
-- [ASN](https://ipinfo.io/asn-api) (ISP or network operator, associated domain name, and type, such as business, hosting or company)
+- [Geolocation](https://ipinfo.io/ip-geolocation-api) (city, region, country, postal code, latitude, and longitude)
+- [ASN](https://ipinfo.io/asn-api) (ISP or network operator, associated domain name, and type, such as business, hosting, or company)
 - [Company](https://ipinfo.io/ip-company-api) (the name and domain of the business that uses the IP address)
 - [Carrier](https://ipinfo.io/ip-carrier-api) (the name of the mobile carrier and MNC and MCC for that carrier if the IP is used exclusively for mobile traffic)
 
@@ -11,10 +11,12 @@ Check all the data we have for your IP address [here](https://ipinfo.io/what-is-
 
 ## 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).
+You'll need an IPinfo API access token, which you can get by signing up for a free account at [https://ipinfo.io/signup](https://ipinfo.io/signup).
 
 The free plan is limited to 50,000 requests per month, 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)
 
+The library also supports the Lite API, see the [Lite API section](#lite-api) for more info.
+
 ### Installation
 
 1. Option 1) Add this line to your application's Gemfile:
@@ -118,9 +120,11 @@ request.env['ipinfo'].all ==
 
 ## Configuration
 
- In addition to the steps listed in the Installation section it is possible to configure the library with more detail. The following arguments are allowed and are described in detail below.
+ In addition to the steps listed in the Installation section, it is possible to configure the library with more detail. The following arguments are allowed and are described in detail below.
 
 ```ruby
+require 'ipinfo-rails/ip_selector/xforwarded_ip_selector'
+
 config.middleware.use(IPinfoMiddleware, {
   token: "<your_token>",
   ttl: "",
@@ -129,6 +133,31 @@ config.middleware.use(IPinfoMiddleware, {
   http_client: "",
   countries: "",
   filter: "",
+  ip_selector: XForwardedIPSelector,
+})
+```
+
+### IP Selection Mechanism
+
+By default, the source IP on the request is used as the input to IP geolocation.
+
+Since the actual desired IP may be something else, the IP selection mechanism is configurable.
+
+Here are some built-in mechanisms:
+
+- [DefaultIPSelector](./lib/ipinfo-rails/ip_selector/default_ip_selector.rb)
+- [XForwardedIPSelector](./lib/ipinfo-rails/ip_selector/xforwarded_ip_selector.rb)
+
+#### Using a custom IP selector
+
+In case a custom IP selector is required, you may implement the `IPSelectorInterface` and pass the class to `ip_selector` in config.
+
+```ruby
+require 'custom-package/custom_ip_selector'
+
+config.middleware.use(IPinfoMiddleware, {
+  token: "<your_token>",
+  ip_selector: CustomIPSelector,
 })
 ```
 
@@ -217,9 +246,22 @@ config.middleware.use(IPinfoMiddleware, {
 
 This simple lambda function will filter out requests coming from your local computer.
 
+## Lite API
+
+The library gives the possibility to use the [Lite API](https://ipinfo.io/developers/lite-api) too, authentication with your token is still required.
+
+The returned details are slightly different from the Core API, but it has the same configurations options.
+
+You can use it like so:
+
+```ruby
+require 'ipinfo-rails'
+config.middleware.use(IPinfoLiteMiddleware, {token: "<your_token>"})
+```
+
 ## 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.
+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
 

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+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/ipinfo-rails.gemspec

@@ -9,7 +9,6 @@ Gem::Specification.new do |s|
     s.name = 'ipinfo-rails'
     s.version = IPinfoRails::VERSION
     s.required_ruby_version = '>= 2.5.0'
-    s.date = '2018-12-10'
     s.summary = 'The official Rails gem for IPinfo. IPinfo prides itself on ' \
                 'being the most reliable, accurate, and in-depth source of ' \
                 'IP address data available anywhere. We process terabytes ' \
@@ -17,16 +16,21 @@ Gem::Specification.new do |s|
                 'carrier and IP type data sets. You can visit our developer ' \
                 'docs at https://ipinfo.io/developers.'
     s.description = s.summary
-    s.authors = ['James Timmins', 'Uman Shahzad']
-    s.email = ['jameshtimmins@gmail.com', 'uman@mslm.io']
+    s.authors = ['IPinfo releases']
+    s.email = ['releases@ipinfo.io']
     s.homepage = 'https://ipinfo.io'
     s.license = 'Apache-2.0'
 
-    s.add_runtime_dependency 'IPinfo', '~> 1.0.1'
-    s.add_runtime_dependency 'rack', '~> 2.0'
+    s.add_dependency 'IPinfo', '~> 2.3'
+    s.add_dependency 'rack', '~> 2.0'
+
+    s.add_development_dependency 'mocha', '~> 2.7'
 
     s.files = `git ls-files -z`.split("\x0").reject do |f|
         f.match(%r{^(test|spec|features)/})
     end
     s.require_paths = ['lib']
+    s.metadata = {
+        'rubygems_mfa_required' => 'true'
+    }
 end

data/lib/ipinfo-rails/ip_selector/default_ip_selector.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require 'ipinfo-rails/ip_selector/ip_selector_interface'
+
+class DefaultIPSelector
+    include IPSelectorInterface
+
+    def initialize(request)
+        @request = request
+    end
+    
+    def get_ip()
+        return @request.ip
+    end
+end

data/lib/ipinfo-rails/ip_selector/ip_selector_interface.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module IPSelectorInterface
+    class InterfaceNotImplemented < StandardError; end
+    def get_ip()
+        raise InterfaceNotImplemented
+    end
+end

data/lib/ipinfo-rails/ip_selector/xforwarded_ip_selector.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require 'ipinfo-rails/ip_selector/ip_selector_interface'
+
+class XForwardedIPSelector
+    include IPSelectorInterface
+
+    def initialize(request)
+        @request = request
+    end
+    
+    def get_ip()
+        x_forwarded = @request.env['HTTP_X_FORWARDED_FOR']
+        if !x_forwarded || x_forwarded.empty?
+            return @request.ip
+        else
+            return x_forwarded.split(',' , -1)[0]
+        end
+    end
+end

data/lib/ipinfo-rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IPinfoRails
-    VERSION = '1.0.1'
+    VERSION = '1.1.0'
 end

data/lib/ipinfo-rails.rb

@@ -2,19 +2,31 @@
 
 require 'rack'
 require 'ipinfo'
+require 'ipinfo_lite'
+require 'ipinfo-rails/ip_selector/default_ip_selector'
+
+def is_bot(request)
+  if request.user_agent
+    user_agent = request.user_agent.downcase
+    user_agent.include?('bot') || user_agent.include?('spider')
+  else
+    false
+  end
+end
 
 class IPinfoMiddleware
-    def initialize(app, cache_options = {})
+    def initialize(app, options = {})
         @app = app
-        @token = cache_options.fetch(:token, nil)
-        @ipinfo = IPinfo.create(@token, cache_options)
-        @filter = cache_options.fetch(:filter, nil)
+        @token = options.fetch(:token, nil)
+        @ipinfo = IPinfo.create(@token, options)
+        @filter = options.fetch(:filter, nil)
+        @ip_selector = options.fetch(:ip_selector, DefaultIPSelector)
     end
 
     def call(env)
         env['called'] = 'yes'
         request = Rack::Request.new(env)
-
+        ip_selector = @ip_selector.new(request)
         filtered = if @filter.nil?
                        is_bot(request)
                    else
@@ -24,21 +36,40 @@ class IPinfoMiddleware
         if filtered
             env['ipinfo'] = nil
         else
-            ip = request.ip
+            ip = ip_selector.get_ip()
             env['ipinfo'] = @ipinfo.details(ip)
         end
 
         @app.call(env)
     end
+end
 
-    private
+class IPinfoLiteMiddleware
+  def initialize(app, options = {})
+    @app = app
+    @token = options.fetch(:token, nil)
+    @ipinfo = IPinfoLite.create(@token, options)
+    @filter = options.fetch(:filter, nil)
+    @ip_selector = options.fetch(:ip_selector, DefaultIPSelector)
+  end
 
-    def is_bot(request)
-        if request.user_agent
-            user_agent = request.user_agent.downcase
-            user_agent.include?('bot') || user_agent.include?('spider')
-        else
-            false
-        end
+  def call(env)
+    env['called'] = 'yes'
+    request = Rack::Request.new(env)
+    ip_selector = @ip_selector.new(request)
+    filtered = if @filter.nil?
+                 is_bot(request)
+               else
+                 @filter.call(request)
+               end
+
+    if filtered
+      env['ipinfo'] = nil
+    else
+      ip = ip_selector.get_ip
+      env['ipinfo'] = @ipinfo.details(ip)
     end
+
+    @app.call(env)
+  end
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ipinfo-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
-- James Timmins
-- Uman Shahzad
-autorequire: 
+- IPinfo releases
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-12-10 00:00:00.000000000 Z
+date: 2025-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: IPinfo
@@ -17,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -39,30 +38,49 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
 description: The official Rails gem for IPinfo. 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. You can visit our developer docs at https://ipinfo.io/developers.
 email:
-- jameshtimmins@gmail.com
-- uman@mslm.io
+- releases@ipinfo.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
 - Gemfile
 - README.md
+- Rakefile
 - ipinfo-rails.gemspec
 - lib/ipinfo-rails.rb
+- lib/ipinfo-rails/ip_selector/default_ip_selector.rb
+- lib/ipinfo-rails/ip_selector/ip_selector_interface.rb
+- lib/ipinfo-rails/ip_selector/xforwarded_ip_selector.rb
 - lib/ipinfo-rails/version.rb
 homepage: https://ipinfo.io
 licenses:
 - Apache-2.0
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -77,8 +95,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: The official Rails gem for IPinfo. IPinfo prides itself on being the most
   reliable, accurate, and in-depth source of IP address data available anywhere. We