maxmind-geoip2 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42699226c0ab8ec1152f4c56929c830916d7c226097082ae95959199d8796aa8
-  data.tar.gz: 97d399a1c58fb932171cfb4aa5c6b19cfb64af382771e2cdfc693e72bba2abd1
+  metadata.gz: 874135d664c0af2e82c184ce30fffbdfe72bb6badc1aa53ee0ec5eba626e5a1d
+  data.tar.gz: 7aec662f3893322c983f647545f4a155b27bda20b7fd6349201fc386264bdc88
 SHA512:
-  metadata.gz: cd7fac3bc1738b562586e23722eb62919a3d157a32619511ca2246b0b23c91eabcf9a3565e9f33ff080680bdb9e42a6cfaf984689de9231e8cc2b4edab5b5fa9
-  data.tar.gz: 05ce00df88e5de2ecfc7fceacc868fdf5d0b371091d7da5aae63089f9699c72195aaf70175fcdd8e16c3af4d251cd2cf8b78f06e462c2936ea66cc82a4ed622d
+  metadata.gz: 3b5d57920b467ccae6144b6f4aca8266721124481917014025390f02f6728138b704513137596593226506f82d554cf77afb215921a13fa8622e1b4e3a4f8b43
+  data.tar.gz: 28be946c7ea163e61b641029f3094de7b47ac2ce8bec6d1c68f9ddd5d084f55419403daeb30762fce3d0346ea0fb083de0d946621f6d659eabe03cafe3c3d0dd

data/CHANGELOG.md

@@ -1,5 +1,40 @@
 # Changelog
 
+## 1.0.0 (2021-05-14)
+
+* Ruby 2.4 is no longer supported. If you're using Ruby 2.4, please use
+  version 0.7.0 of this gem.
+* Expand accepted versions of the `http` gem to include 5.0+.
+* Bump version to 1.0.0 since we have been at 0.x for over a year. There is
+  no breaking change.
+
+## 0.7.0 (2021-03-24)
+
+* Ensured defaults are set when creating a `MaxMind::GeoIP2::Client` in the
+  case when args are explicitly passed in as `nil`. Pull Request by Manoj
+  Dayaram. GitHub #31.
+
+## 0.6.0 (2021-03-23)
+
+* Updated the `MaxMind::GeoIP2::Reader` constructor to support being called
+  using keyword arguments. For example, you may now create a `Reader` using
+  `MaxMind::GeoIP2::Reader.new(database: 'GeoIP2-Country.mmdb')` instead of
+  using positional arguments. This is intended to make it easier to pass in
+  optional arguments. Positional argument calling is still supported.
+* Proxy support was fixed. Pull request by Manoj Dayaram. GitHub #30.
+
+## 0.5.0 (2020-09-25)
+
+* Added the `residential_proxy?` method to
+  `MaxMind::GeoIP2::Model::AnonymousIP` and
+  `MaxMind::GeoIP2::Record::Traits` for use with the Anonymous IP database
+  and GeoIP2 Precision Insights.
+
+## 0.4.0 (2020-03-06)
+
+* HTTP connections are now persistent. There is a new parameter that
+  controls the maximum number of connections the client will use.
+
 ## 0.3.0 (2020-03-04)
 
 * Modules are now always be defined. Previously we used a shorthand syntax

data/Gemfile

@@ -2,10 +2,4 @@
 
 source 'https://rubygems.org'
 
-gem 'http'
-gem 'maxmind-db'
-gem 'minitest', group: :development
-gem 'rake', group: :development
-gem 'rubocop', group: :development
-gem 'rubocop-performance', group: :development
-gem 'webmock', group: :development
+gemspec

data/README.dev.md

@@ -1,4 +1,4 @@
 # How to release
 
 See
-[here](https://github.com/maxmind/MaxMind-DB-Reader-ruby/blob/master/README.dev.md).
+[here](https://github.com/maxmind/MaxMind-DB-Reader-ruby/blob/main/README.dev.md).

data/README.md

@@ -47,7 +47,9 @@ for more details.
 require 'maxmind/geoip2'
 
 # This creates the Reader object which should be reused across lookups.
-reader = MaxMind::GeoIP2::Reader.new('/usr/share/GeoIP/GeoIP2-City.mmdb')
+reader = MaxMind::GeoIP2::Reader.new(
+  database: '/usr/share/GeoIP/GeoIP2-City.mmdb',
+)
 
 record = reader.city('128.101.101.101')
 
@@ -74,7 +76,9 @@ puts record.traits.network # 128.101.101.101/32
 require 'maxmind/geoip2'
 
 # This creates the Reader object which should be reused across lookups.
-reader = MaxMind::GeoIP2::Reader.new('/usr/share/GeoIP/GeoIP2-Country.mmdb')
+reader = MaxMind::GeoIP2::Reader.new(
+  database: '/usr/share/GeoIP/GeoIP2-Country.mmdb',
+)
 
 record = reader.country('128.101.101.101')
 
@@ -89,7 +93,9 @@ puts record.country.names['zh-CN'] # '美国'
 require 'maxmind/geoip2'
 
 # This creates the Reader object which should be reused across lookups.
-reader = MaxMind::GeoIP2::Reader.new('/usr/share/GeoIP/GeoIP2-Enterprise.mmdb')
+reader = MaxMind::GeoIP2::Reader.new(
+  database: '/usr/share/GeoIP/GeoIP2-Enterprise.mmdb',
+)
 
 record = reader.enterprise('128.101.101.101')
 
@@ -120,7 +126,9 @@ puts record.traits.network # 128.101.101.101/32
 require 'maxmind/geoip2'
 
 # This creates the Reader object which should be reused across lookups.
-reader = MaxMind::GeoIP2::Reader.new('/usr/share/GeoIP/GeoIP2-Anonymous-IP.mmdb')
+reader = MaxMind::GeoIP2::Reader.new(
+  database: '/usr/share/GeoIP/GeoIP2-Anonymous-IP.mmdb',
+)
 
 record = reader.anonymous_ip('128.101.101.101')
 
@@ -133,7 +141,9 @@ puts "Anonymous" if record.is_anonymous
 require 'maxmind/geoip2'
 
 # This creates the Reader object which should be reused across lookups.
-reader = MaxMind::GeoIP2::Reader.new('/usr/share/GeoIP/GeoLite2-ASN.mmdb')
+reader = MaxMind::GeoIP2::Reader.new(
+  database: '/usr/share/GeoIP/GeoLite2-ASN.mmdb',
+)
 
 record = reader.asn('128.101.101.101')
 
@@ -147,7 +157,9 @@ puts record.autonomous_system_organization # Example Ltd
 require 'maxmind/geoip2'
 
 # This creates the Reader object which should be reused across lookups.
-reader = MaxMind::GeoIP2::Reader.new('/usr/share/GeoIP/GeoIP2-Connection-Type.mmdb')
+reader = MaxMind::GeoIP2::Reader.new(
+  database: '/usr/share/GeoIP/GeoIP2-Connection-Type.mmdb',
+)
 
 record = reader.connection_type('128.101.101.101')
 
@@ -160,7 +172,9 @@ puts record.connection_type # Cable/DSL
 require 'maxmind/geoip2'
 
 # This creates the Reader object which should be reused across lookups.
-reader = MaxMind::GeoIP2::Reader.new('/usr/share/GeoIP/GeoIP2-Domain.mmdb')
+reader = MaxMind::GeoIP2::Reader.new(
+  database: '/usr/share/GeoIP/GeoIP2-Domain.mmdb',
+)
 
 record = reader.domain('128.101.101.101')
 
@@ -173,7 +187,9 @@ puts record.domain # example.com
 require 'maxmind/geoip2'
 
 # This creates the Reader object which should be reused across lookups.
-reader = MaxMind::GeoIP2::Reader.new('/usr/share/GeoIP/GeoIP2-ISP.mmdb')
+reader = MaxMind::GeoIP2::Reader.new(
+  database: '/usr/share/GeoIP/GeoIP2-ISP.mmdb',
+)
 
 record = reader.isp('128.101.101.101')
 
@@ -188,9 +204,10 @@ puts record.organization # University of Minnesota
 ### Usage
 
 To use this API, you must create a new `MaxMind::GeoIP2::Client` object
-with your account ID and license key, then you call the method
-corresponding to a specific end point, passing it the IP address you want
-to look up.
+with your account ID and license key. To use the GeoLite2 web service, you
+may also set the `host` parameter to `geolite.info`. You may then you call
+the method corresponding to a specific end point, passing it the IP address
+you want to look up.
 
 If the request succeeds, the method call will return a model class for the end
 point you called. This model in turn contains multiple record classes, each of
@@ -212,13 +229,18 @@ require 'maxmind/geoip2'
 client = MaxMind::GeoIP2::Client.new(
   account_id: 42,
   license_key: 'license_key',
+
+  # To use the GeoLite2 web service instead of GeoIP2 Precision, set
+  # the host parameter to "geolite.info":
+  # host: 'geolite.info',
 )
 
 # Replace "city" with the method corresponding to the web service that
-# you are using, e.g., "country", "insights".
+# you are using, e.g., "country", "insights". Please note that Insights
+# is only supported by GeoIP2 Precision and not the GeoLite2 web service.
 record = client.city('128.101.101.101')
 
-puts record.country.isoCode # US
+puts record.country.iso_code # US
 puts record.country.name # United States
 puts record.country.names['zh-CN'] # 美国
 
@@ -307,7 +329,7 @@ client API, please see [our support page](https://www.maxmind.com/en/support).
 
 ## Requirements
 
-This code requires Ruby version 2.4 or higher.
+This code requires Ruby version 2.5 or higher.
 
 ## Contributing
 
@@ -320,7 +342,7 @@ This library uses [Semantic Versioning](https://semver.org/).
 
 ## Copyright and License
 
-This software is Copyright (c) 2020 by MaxMind, Inc.
+This software is Copyright (c) 2020-2021 by MaxMind, Inc.
 
 This is free software, licensed under the [Apache License, Version
 2.0](LICENSE-APACHE) or the [MIT License](LICENSE-MIT), at your option.

data/lib/maxmind/geoip2/client.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'connection_pool'
 require 'http'
 require 'json'
 require 'maxmind/geoip2/errors'
@@ -54,6 +55,8 @@ module MaxMind
     #   puts record.country.iso_code
     class Client
       # rubocop:disable Metrics/ParameterLists
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/PerceivedComplexity
 
       # Create a Client that may be used to query a GeoIP2 Precision web service.
       #
@@ -67,7 +70,9 @@ module MaxMind
       # @param locales [Array<String>] a list of locale codes to use in the name
       #   property from most preferred to least preferred.
       #
-      # @param host [String] the host to use when querying the web service.
+      # @param host [String] the host to use when querying the web service. Set
+      #   this to "geolite.info" to use the GeoLite2 web service instead of
+      #   GeoIP2 Precision.
       #
       # @param timeout [Integer] the number of seconds to wait for a request
       #   before timing out. If 0, no timeout is set.
@@ -79,6 +84,8 @@ module MaxMind
       # @param proxy_username [String] proxy username to use, if any.
       #
       # @param proxy_password [String] proxy password to use, if any.
+      #
+      # @param pool_size [Integer] HTTP connection pool size
       def initialize(
         account_id:,
         license_key:,
@@ -88,21 +95,29 @@ module MaxMind
         proxy_address: '',
         proxy_port: 0,
         proxy_username: '',
-        proxy_password: ''
+        proxy_password: '',
+        pool_size: 5
       )
         @account_id = account_id
         @license_key = license_key
-        @locales = locales
-        @host = host
-        @timeout = timeout
-        @proxy_address = proxy_address
-        @proxy_port = proxy_port
-        @proxy_username = proxy_username
-        @proxy_password = proxy_password
+        @locales = locales || ['en']
+        @host = host || 'geoip.maxmind.com'
+        @timeout = timeout || 0
+        @proxy_address = proxy_address || ''
+        @proxy_port = proxy_port || 0
+        @proxy_username = proxy_username || ''
+        @proxy_password = proxy_password || ''
+        @pool_size = pool_size || 5
+
+        @connection_pool = ConnectionPool.new(size: @pool_size) do
+          make_http_client.persistent("https://#{@host}")
+        end
       end
+      # rubocop:enable Metrics/PerceivedComplexity
+      # rubocop:enable Metrics/CyclomaticComplexity
       # rubocop:enable Metrics/ParameterLists
 
-      # This method calls the GeoIP2 Precision City web service.
+      # This method calls the City web service.
       #
       # @param ip_address [String] IPv4 or IPv6 address as a string. If no
       #   address is provided, the address that the web service is called from is
@@ -139,7 +154,7 @@ module MaxMind
         response_for('city', MaxMind::GeoIP2::Model::City, ip_address)
       end
 
-      # This method calls the GeoIP2 Precision Country web service.
+      # This method calls the Country web service.
       #
       # @param ip_address [String] IPv4 or IPv6 address as a string. If no
       #   address is provided, the address that the web service is called from is
@@ -176,7 +191,10 @@ module MaxMind
         response_for('country', MaxMind::GeoIP2::Model::Country, ip_address)
       end
 
-      # This method calls the GeoIP2 Precision Insights web service.
+      # This method calls the Insights web service.
+      #
+      # Insights is only supported by the GeoIP2 Precision web service. The
+      # GeoLite2 web service does not support it.
       #
       # @param ip_address [String] IPv4 or IPv6 address as a string. If no
       #   address is provided, the address that the web service is called from is
@@ -221,11 +239,7 @@ module MaxMind
         model_class.new(record, @locales)
       end
 
-      # rubocop:disable Metrics/CyclomaticComplexity
-      # rubocop:disable Metrics/PerceivedComplexity
-      def get(endpoint, ip_address)
-        url = 'https://' + @host + '/geoip/v2.1/' + endpoint + '/' + ip_address
-
+      def make_http_client
         headers = HTTP.basic_auth(user: @account_id, pass: @license_key)
                       .headers(
                         accept: 'application/json',
@@ -235,16 +249,26 @@ module MaxMind
 
         proxy = timeout
         if @proxy_address != ''
-          opts = {}
-          opts[:proxy_port] = @proxy_port if @proxy_port != 0
-          opts[:proxy_username] = @proxy_username if @proxy_username != ''
-          opts[:proxy_password] = @proxy_password if @proxy_password != ''
-          proxy = timeout.via(@proxy_address, opts)
+          proxy_params = [@proxy_address]
+          proxy_params << (@proxy_port == 0 ? nil : @proxy_port)
+          proxy_params << (@proxy_username == '' ? nil : @proxy_username)
+          proxy_params << (@proxy_password == '' ? nil : @proxy_password)
+          proxy = timeout.via(*proxy_params)
         end
 
-        response = proxy.get(url)
+        proxy
+      end
+
+      def get(endpoint, ip_address)
+        url = "/geoip/v2.1/#{endpoint}/#{ip_address}"
+
+        response = nil
+        body = nil
+        @connection_pool.with do |client|
+          response = client.get(url)
+          body = response.to_s
+        end
 
-        body = response.to_s
         is_json = response.headers[:content_type]&.include?('json')
 
         if response.status.client_error?
@@ -263,8 +287,6 @@ module MaxMind
 
         handle_success(endpoint, body, is_json)
       end
-      # rubocop:enable Metrics/CyclomaticComplexity
-      # rubocop:enable Metrics/PerceivedComplexity
 
       # rubocop:disable Metrics/CyclomaticComplexity
       def handle_client_error(endpoint, status, body, is_json)

data/lib/maxmind/geoip2/model/anonymous_ip.rb

@@ -55,6 +55,14 @@ module MaxMind
           get('is_public_proxy')
         end
 
+        # This is true if the IP address is on a suspected anonymizing network
+        # and belongs to a residential ISP.
+        #
+        # @return [Boolean]
+        def residential_proxy?
+          get('is_residential_proxy')
+        end
+
         # This is true if the IP address is a Tor exit node.
         #
         # @return [Boolean]

data/lib/maxmind/geoip2/reader.rb

@@ -20,13 +20,16 @@ module MaxMind
     #
     #   require 'maxmind/geoip2'
     #
-    #   reader = MaxMind::GeoIP2::Reader.new('GeoIP2-Country.mmdb')
+    #   reader = MaxMind::GeoIP2::Reader.new(database: 'GeoIP2-Country.mmdb')
     #
     #   record = reader.country('1.2.3.4')
     #   puts record.country.iso_code
     #
     #   reader.close
     class Reader
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/PerceivedComplexity
+
       # Create a Reader for looking up IP addresses in a GeoIP2/GeoLite2 database
       # file.
       #
@@ -37,30 +40,52 @@ module MaxMind
       # threads. It is safe to use after forking only if you use
       # MaxMind::DB::MODE_MEMORY or if your version of Ruby supports IO#pread.
       #
-      # @param database [String] a path to a GeoIP2/GeoLite2 database file.
-      #
-      # @param locales [Array<String>] a list of locale codes to use in the name
-      #   property from most preferred to least preferred.
-      #
-      # @param options [Hash<Symbol, Symbol>] options controlling the behavior of
-      #   the Reader.
+      # @overload initialize(database:, locales: ['en'], mode: MaxMind::DB::MODE_AUTO)
+      #   @param database [String] a path to a GeoIP2/GeoLite2 database file.
+      #   @param locales [Array<String>] a list of locale codes to use in the name
+      #     property from most preferred to least preferred.
+      #   @param mode [Symbol] Defines how to open the database. It may be one of
+      #     MaxMind::DB::MODE_AUTO, MaxMind::DB::MODE_FILE, or
+      #     MaxMind::DB::MODE_MEMORY. If you don't provide one, the Reader uses
+      #     MaxMind::DB::MODE_AUTO. Refer to the definition of those constants in
+      #     MaxMind::DB for an explanation of their meaning.
       #
-      # @option options [Symbol] :mode Defines how to open the database. It may
-      #   be one of MaxMind::DB::MODE_AUTO, MaxMind::DB::MODE_FILE, or
-      #   MaxMind::DB::MODE_MEMORY. If you don't provide one, the Reader uses
-      #   MaxMind::DB::MODE_AUTO. Refer to the definition of those constants in
-      #   MaxMind::DB for an explanation of their meaning.
-      #
-      # @raise [MaxMind::DB::InvalidDatabaseError] if the database is corrupt or
-      #   invalid.
+      # @raise [MaxMind::DB::InvalidDatabaseError] if the database is corrupt
+      #   or invalid.
       #
       # @raise [ArgumentError] if the mode is invalid.
-      def initialize(database, locales = ['en'], options = {})
+      def initialize(*args)
+        # This if statement is to let us support calling as though we are using
+        # Ruby 2.0 keyword arguments. We can't use keyword argument syntax as
+        # we want to be backwards compatible with the old way we accepted
+        # parameters, which looked like:
+        # def initialize(database, locales = ['en'], options = {})
+        if args.length == 1 && args[0].instance_of?(Hash)
+          database = args[0][:database]
+          locales = args[0][:locales]
+          mode = args[0][:mode]
+        else
+          database = args[0]
+          locales = args[1]
+          mode = args[2].instance_of?(Hash) ? args[2][:mode] : nil
+        end
+
+        if !database.instance_of?(String)
+          raise ArgumentError, 'Invalid database parameter'
+        end
+
+        locales = ['en'] if locales.nil? || locales.empty?
+
+        options = {}
+        options[:mode] = mode if !mode.nil?
         @reader = MaxMind::DB.new(database, options)
+
         @type = @reader.metadata.database_type
-        locales = ['en'] if locales.empty?
+
         @locales = locales
       end
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/PerceivedComplexity
 
       # Look up the IP address in the database.
       #