maxmind-geoip2 0.2.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 107c7822a5a2de18a3339637547ca8fd8eef5163
-  data.tar.gz: 8d730256e5f036178cf13cbd69ed5be2b86afc10
+SHA256:
+  metadata.gz: 499989805675afe47c253b34e265f655f79988d6fdbbb26a15c6a1147f512462
+  data.tar.gz: e39f9567d2ad3e8a5ca07f5f3faa6476368d27359ae2283e23c6b2aa31f11844
 SHA512:
-  metadata.gz: 1c9dc8f9b3a115494fa9f20c603f772721568a3759b9e2619fde20751ba71a50109d911effeb7d702d286a2011e56d71049ff6a2b854b177f012bbf6bd904291
-  data.tar.gz: a895b54353186ad7fdffec41d9fcf0efa03f093f2dd44a7bbe31e417e13e726a971bb4b88a8a7357c424b16d864061aa563aa150b87160a087d025e852be9a60
+  metadata.gz: 1dcc366745377b4de4189813d2e264010e3f2794b67f6e10a404285d585dd65f76decd7c711accf0fbbe7ca2c68c1063e9e9a168fd73e1f7699cbcbd54c0699d
+  data.tar.gz: 8b76fb4b2e4217bbba2a9d21f108c604406f17c335cb90959acd83808d93f664d4825d7da1aa49e9d6d5fbf266c91473746ee79cbbeabb7b64d49e0e0a9e6fee

data/CHANGELOG.md

@@ -1,5 +1,38 @@
 # Changelog
 
+## 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
+  which meant including individual classes could leave module constants
+  undefined.
+
 ## 0.2.0 (2020-02-26)
 
 * Added support for the GeoIP2 Precision web services: Country, City, and

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'] # 美国
 
@@ -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'
@@ -7,307 +8,330 @@ require 'maxmind/geoip2/model/city'
 require 'maxmind/geoip2/model/country'
 require 'maxmind/geoip2/model/insights'
 
-module MaxMind::GeoIP2
-  # This class provides a client API for all the
-  # {https://dev.maxmind.com/geoip/geoip2/web-services/ GeoIP2 Precision web
-  # services}. The services are Country, City, and Insights. Each service
-  # returns a different set of data about an IP address, with Country returning
-  # the least data and Insights the most.
-  #
-  # Each web service is represented by a different model class, and these model
-  # classes in turn contain multiple record classes. The record classes have
-  # attributes which contain data about the IP address.
-  #
-  # If the web service does not return a particular piece of data for an IP
-  # address, the associated attribute is not populated.
-  #
-  # The web service may not return any information for an entire record, in
-  # which case all of the attributes for that record class will be empty.
-  #
-  # == Usage
-  #
-  # The basic API for this class is the same for all of the web service end
-  # points. First you create a web service client object with your MaxMind
-  # 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.
-  #
-  # If the request succeeds, the method call will return a model class for the
-  # service you called. This model in turn contains multiple record classes,
-  # each of which represents part of the data returned by the web service.
-  #
-  # If the request fails, the client class throws an exception.
-  #
-  # == Example
-  #
-  #   require 'maxmind/geoip2'
-  #
-  #   client = MaxMind::GeoIP2::Client.new(
-  #     account_id: 42,
-  #     license_key: 'abcdef123456',
-  #   )
-  #
-  #   # Replace 'city' with the method corresponding to the web service you
-  #   # are using, e.g., 'country', 'insights'.
-  #   record = client.city('128.101.101.101')
-  #
-  #   puts record.country.iso_code
-  class Client
-    # rubocop:disable Metrics/ParameterLists
-
-    # Create a Client that may be used to query a GeoIP2 Precision web service.
-    #
-    # Once created, the Client is safe to use for lookups from multiple
-    # threads.
-    #
-    # @param account_id [Integer] your MaxMind account ID.
-    #
-    # @param license_key [String] your MaxMind license key.
-    #
-    # @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 timeout [Integer] the number of seconds to wait for a request
-    #   before timing out. If 0, no timeout is set.
+module MaxMind
+  module GeoIP2
+    # This class provides a client API for all the
+    # {https://dev.maxmind.com/geoip/geoip2/web-services/ GeoIP2 Precision web
+    # services}. The services are Country, City, and Insights. Each service
+    # returns a different set of data about an IP address, with Country returning
+    # the least data and Insights the most.
     #
-    # @param proxy_address [String] proxy address to use, if any.
+    # Each web service is represented by a different model class, and these model
+    # classes in turn contain multiple record classes. The record classes have
+    # attributes which contain data about the IP address.
     #
-    # @param proxy_port [Integer] proxy port to use, if any.
+    # If the web service does not return a particular piece of data for an IP
+    # address, the associated attribute is not populated.
     #
-    # @param proxy_username [String] proxy username to use, if any.
+    # The web service may not return any information for an entire record, in
+    # which case all of the attributes for that record class will be empty.
     #
-    # @param proxy_password [String] proxy password to use, if any.
-    def initialize(
-      account_id:,
-      license_key:,
-      locales: ['en'],
-      host: 'geoip.maxmind.com',
-      timeout: 0,
-      proxy_address: '',
-      proxy_port: 0,
-      proxy_username: '',
-      proxy_password: ''
-    )
-      @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
-    end
-    # rubocop:enable Metrics/ParameterLists
-
-    # This method calls the GeoIP2 Precision 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
-    #   used.
-    #
-    # @raise [HTTP::Error] if there was an error performing the HTTP request,
-    #   such as an error connecting.
+    # == Usage
     #
-    # @raise [JSON::ParserError] if there was invalid JSON in the response.
+    # The basic API for this class is the same for all of the web service end
+    # points. First you create a web service client object with your MaxMind
+    # 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.
     #
-    # @raise [HTTPError] if there was a problem with the HTTP response, such as
-    #   an unexpected HTTP status code.
+    # If the request succeeds, the method call will return a model class for the
+    # service you called. This model in turn contains multiple record classes,
+    # each of which represents part of the data returned by the web service.
     #
-    # @raise [AddressInvalidError] if the web service believes the IP address
-    #   to be invalid or missing.
+    # If the request fails, the client class throws an exception.
     #
-    # @raise [AddressNotFoundError] if the IP address was not found.
+    # == Example
     #
-    # @raise [AddressReservedError] if the IP address is reserved.
+    #   require 'maxmind/geoip2'
     #
-    # @raise [AuthenticationError] if there was a problem authenticating to the
-    #   web service, such as an invalid or missing license key.
+    #   client = MaxMind::GeoIP2::Client.new(
+    #     account_id: 42,
+    #     license_key: 'abcdef123456',
+    #   )
     #
-    # @raise [InsufficientFundsError] if your account is out of credit.
+    #   # Replace 'city' with the method corresponding to the web service you
+    #   # are using, e.g., 'country', 'insights'.
+    #   record = client.city('128.101.101.101')
     #
-    # @raise [PermissionRequiredError] if your account does not have permission
-    #   to use the web service.
-    #
-    # @raise [InvalidRequestError] if the web service responded with an error
-    #   and there is no more specific error to raise.
-    #
-    # @return [MaxMind::GeoIP2::Model::City]
-    def city(ip_address = 'me')
-      response_for('city', MaxMind::GeoIP2::Model::City, ip_address)
-    end
+    #   puts record.country.iso_code
+    class Client
+      # rubocop:disable Metrics/ParameterLists
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/PerceivedComplexity
 
-    # This method calls the GeoIP2 Precision 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
-    #   used.
-    #
-    # @raise [HTTP::Error] if there was an error performing the HTTP request,
-    #   such as an error connecting.
-    #
-    # @raise [JSON::ParserError] if there was invalid JSON in the response.
-    #
-    # @raise [HTTPError] if there was a problem with the HTTP response, such as
-    #   an unexpected HTTP status code.
-    #
-    # @raise [AddressInvalidError] if the web service believes the IP address
-    #   to be invalid or missing.
-    #
-    # @raise [AddressNotFoundError] if the IP address was not found.
-    #
-    # @raise [AddressReservedError] if the IP address is reserved.
-    #
-    # @raise [AuthenticationError] if there was a problem authenticating to the
-    #   web service, such as an invalid or missing license key.
-    #
-    # @raise [InsufficientFundsError] if your account is out of credit.
-    #
-    # @raise [PermissionRequiredError] if your account does not have permission
-    #   to use the web service.
-    #
-    # @raise [InvalidRequestError] if the web service responded with an error
-    #   and there is no more specific error to raise.
-    #
-    # @return [MaxMind::GeoIP2::Model::Country]
-    def country(ip_address = 'me')
-      response_for('country', MaxMind::GeoIP2::Model::Country, ip_address)
-    end
+      # Create a Client that may be used to query a GeoIP2 Precision web service.
+      #
+      # Once created, the Client is safe to use for lookups from multiple
+      # threads.
+      #
+      # @param account_id [Integer] your MaxMind account ID.
+      #
+      # @param license_key [String] your MaxMind license key.
+      #
+      # @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. 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.
+      #
+      # @param proxy_address [String] proxy address to use, if any.
+      #
+      # @param proxy_port [Integer] proxy port to use, if any.
+      #
+      # @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:,
+        locales: ['en'],
+        host: 'geoip.maxmind.com',
+        timeout: 0,
+        proxy_address: '',
+        proxy_port: 0,
+        proxy_username: '',
+        proxy_password: '',
+        pool_size: 5
+      )
+        @account_id = account_id
+        @license_key = license_key
+        @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
 
-    # This method calls the GeoIP2 Precision Insights 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
-    #   used.
-    #
-    # @raise [HTTP::Error] if there was an error performing the HTTP request,
-    #   such as an error connecting.
-    #
-    # @raise [JSON::ParserError] if there was invalid JSON in the response.
-    #
-    # @raise [HTTPError] if there was a problem with the HTTP response, such as
-    #   an unexpected HTTP status code.
-    #
-    # @raise [AddressInvalidError] if the web service believes the IP address
-    #   to be invalid or missing.
-    #
-    # @raise [AddressNotFoundError] if the IP address was not found.
-    #
-    # @raise [AddressReservedError] if the IP address is reserved.
-    #
-    # @raise [AuthenticationError] if there was a problem authenticating to the
-    #   web service, such as an invalid or missing license key.
-    #
-    # @raise [InsufficientFundsError] if your account is out of credit.
-    #
-    # @raise [PermissionRequiredError] if your account does not have permission
-    #   to use the web service.
-    #
-    # @raise [InvalidRequestError] if the web service responded with an error
-    #   and there is no more specific error to raise.
-    #
-    # @return [MaxMind::GeoIP2::Model::Insights]
-    def insights(ip_address = 'me')
-      response_for('insights', MaxMind::GeoIP2::Model::Insights, ip_address)
-    end
+        @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
 
-    private
+      # 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
+      #   used.
+      #
+      # @raise [HTTP::Error] if there was an error performing the HTTP request,
+      #   such as an error connecting.
+      #
+      # @raise [JSON::ParserError] if there was invalid JSON in the response.
+      #
+      # @raise [HTTPError] if there was a problem with the HTTP response, such as
+      #   an unexpected HTTP status code.
+      #
+      # @raise [AddressInvalidError] if the web service believes the IP address
+      #   to be invalid or missing.
+      #
+      # @raise [AddressNotFoundError] if the IP address was not found.
+      #
+      # @raise [AddressReservedError] if the IP address is reserved.
+      #
+      # @raise [AuthenticationError] if there was a problem authenticating to the
+      #   web service, such as an invalid or missing license key.
+      #
+      # @raise [InsufficientFundsError] if your account is out of credit.
+      #
+      # @raise [PermissionRequiredError] if your account does not have permission
+      #   to use the web service.
+      #
+      # @raise [InvalidRequestError] if the web service responded with an error
+      #   and there is no more specific error to raise.
+      #
+      # @return [MaxMind::GeoIP2::Model::City]
+      def city(ip_address = 'me')
+        response_for('city', MaxMind::GeoIP2::Model::City, ip_address)
+      end
 
-    def response_for(endpoint, model_class, ip_address)
-      record = get(endpoint, ip_address)
+      # 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
+      #   used.
+      #
+      # @raise [HTTP::Error] if there was an error performing the HTTP request,
+      #   such as an error connecting.
+      #
+      # @raise [JSON::ParserError] if there was invalid JSON in the response.
+      #
+      # @raise [HTTPError] if there was a problem with the HTTP response, such as
+      #   an unexpected HTTP status code.
+      #
+      # @raise [AddressInvalidError] if the web service believes the IP address
+      #   to be invalid or missing.
+      #
+      # @raise [AddressNotFoundError] if the IP address was not found.
+      #
+      # @raise [AddressReservedError] if the IP address is reserved.
+      #
+      # @raise [AuthenticationError] if there was a problem authenticating to the
+      #   web service, such as an invalid or missing license key.
+      #
+      # @raise [InsufficientFundsError] if your account is out of credit.
+      #
+      # @raise [PermissionRequiredError] if your account does not have permission
+      #   to use the web service.
+      #
+      # @raise [InvalidRequestError] if the web service responded with an error
+      #   and there is no more specific error to raise.
+      #
+      # @return [MaxMind::GeoIP2::Model::Country]
+      def country(ip_address = 'me')
+        response_for('country', MaxMind::GeoIP2::Model::Country, ip_address)
+      end
 
-      model_class.new(record, @locales)
-    end
+      # 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
+      #   used.
+      #
+      # @raise [HTTP::Error] if there was an error performing the HTTP request,
+      #   such as an error connecting.
+      #
+      # @raise [JSON::ParserError] if there was invalid JSON in the response.
+      #
+      # @raise [HTTPError] if there was a problem with the HTTP response, such as
+      #   an unexpected HTTP status code.
+      #
+      # @raise [AddressInvalidError] if the web service believes the IP address
+      #   to be invalid or missing.
+      #
+      # @raise [AddressNotFoundError] if the IP address was not found.
+      #
+      # @raise [AddressReservedError] if the IP address is reserved.
+      #
+      # @raise [AuthenticationError] if there was a problem authenticating to the
+      #   web service, such as an invalid or missing license key.
+      #
+      # @raise [InsufficientFundsError] if your account is out of credit.
+      #
+      # @raise [PermissionRequiredError] if your account does not have permission
+      #   to use the web service.
+      #
+      # @raise [InvalidRequestError] if the web service responded with an error
+      #   and there is no more specific error to raise.
+      #
+      # @return [MaxMind::GeoIP2::Model::Insights]
+      def insights(ip_address = 'me')
+        response_for('insights', MaxMind::GeoIP2::Model::Insights, ip_address)
+      end
 
-    # rubocop:disable Metrics/CyclomaticComplexity
-    # rubocop:disable Metrics/PerceivedComplexity
-    def get(endpoint, ip_address)
-      url = 'https://' + @host + '/geoip/v2.1/' + endpoint + '/' + ip_address
+      private
 
-      headers = HTTP.basic_auth(user: @account_id, pass: @license_key)
-                    .headers(
-                      accept: 'application/json',
-                      user_agent: 'MaxMind-GeoIP2-ruby',
-                    )
-      timeout = @timeout > 0 ? headers.timeout(@timeout) : headers
+      def response_for(endpoint, model_class, ip_address)
+        record = get(endpoint, ip_address)
 
-      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)
+        model_class.new(record, @locales)
       end
 
-      response = proxy.get(url)
+      def make_http_client
+        headers = HTTP.basic_auth(user: @account_id, pass: @license_key)
+                      .headers(
+                        accept: 'application/json',
+                        user_agent: 'MaxMind-GeoIP2-ruby',
+                      )
+        timeout = @timeout > 0 ? headers.timeout(@timeout) : headers
 
-      body = response.to_s
-      is_json = response.headers[:content_type]&.include?('json')
+        proxy = timeout
+        if @proxy_address != ''
+          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
 
-      if response.status.client_error?
-        return handle_client_error(endpoint, response.code, body, is_json)
+        proxy
       end
 
-      if response.status.server_error?
-        raise HTTPError,
-              "Received server error response (#{response.code}) for #{endpoint} with body #{body}"
-      end
+      def get(endpoint, ip_address)
+        url = "/geoip/v2.1/#{endpoint}/#{ip_address}"
 
-      if response.code != 200
-        raise HTTPError,
-              "Received unexpected response (#{response.code}) for #{endpoint} with body #{body}"
-      end
+        response = nil
+        body = nil
+        @connection_pool.with do |client|
+          response = client.get(url)
+          body = response.to_s
+        end
 
-      handle_success(endpoint, body, is_json)
-    end
-    # rubocop:enable Metrics/CyclomaticComplexity
-    # rubocop:enable Metrics/PerceivedComplexity
+        is_json = response.headers[:content_type]&.include?('json')
 
-    # rubocop:disable Metrics/CyclomaticComplexity
-    def handle_client_error(endpoint, status, body, is_json)
-      if !is_json
-        raise HTTPError,
-              "Received client error response (#{status}) for #{endpoint} but it is not JSON: #{body}"
-      end
+        if response.status.client_error?
+          return handle_client_error(endpoint, response.code, body, is_json)
+        end
 
-      error = JSON.parse(body)
+        if response.status.server_error?
+          raise HTTPError,
+                "Received server error response (#{response.code}) for #{endpoint} with body #{body}"
+        end
 
-      if !error.key?('code') || !error.key?('error')
-        raise HTTPError,
-              "Received client error response (#{status}) that is JSON but does not specify code or error keys: #{body}"
-      end
+        if response.code != 200
+          raise HTTPError,
+                "Received unexpected response (#{response.code}) for #{endpoint} with body #{body}"
+        end
 
-      case error['code']
-      when 'IP_ADDRESS_INVALID', 'IP_ADDRESS_REQUIRED'
-        raise AddressInvalidError, error['error']
-      when 'IP_ADDRESS_NOT_FOUND'
-        raise AddressNotFoundError, error['error']
-      when 'IP_ADDRESS_RESERVED'
-        raise AddressReservedError, error['error']
-      when 'ACCOUNT_ID_REQUIRED',
-            'ACCOUNT_ID_UNKNOWN',
-            'AUTHORIZATION_INVALID',
-            'LICENSE_KEY_REQUIRED'
-        raise AuthenticationError, error['error']
-      when 'INSUFFICIENT_FUNDS'
-        raise InsufficientFundsError, error['error']
-      when 'PERMISSION_REQUIRED'
-        raise PermissionRequiredError, error['error']
-      else
-        raise InvalidRequestError, error['error']
+        handle_success(endpoint, body, is_json)
       end
-    end
-    # rubocop:enable Metrics/CyclomaticComplexity
 
-    def handle_success(endpoint, body, is_json)
-      if !is_json
-        raise HTTPError,
-              "Received a success response for #{endpoint} but it is not JSON: #{body}"
+      # rubocop:disable Metrics/CyclomaticComplexity
+      def handle_client_error(endpoint, status, body, is_json)
+        if !is_json
+          raise HTTPError,
+                "Received client error response (#{status}) for #{endpoint} but it is not JSON: #{body}"
+        end
+
+        error = JSON.parse(body)
+
+        if !error.key?('code') || !error.key?('error')
+          raise HTTPError,
+                "Received client error response (#{status}) that is JSON but does not specify code or error keys: #{body}"
+        end
+
+        case error['code']
+        when 'IP_ADDRESS_INVALID', 'IP_ADDRESS_REQUIRED'
+          raise AddressInvalidError, error['error']
+        when 'IP_ADDRESS_NOT_FOUND'
+          raise AddressNotFoundError, error['error']
+        when 'IP_ADDRESS_RESERVED'
+          raise AddressReservedError, error['error']
+        when 'ACCOUNT_ID_REQUIRED',
+              'ACCOUNT_ID_UNKNOWN',
+              'AUTHORIZATION_INVALID',
+              'LICENSE_KEY_REQUIRED'
+          raise AuthenticationError, error['error']
+        when 'INSUFFICIENT_FUNDS'
+          raise InsufficientFundsError, error['error']
+        when 'PERMISSION_REQUIRED'
+          raise PermissionRequiredError, error['error']
+        else
+          raise InvalidRequestError, error['error']
+        end
       end
+      # rubocop:enable Metrics/CyclomaticComplexity
+
+      def handle_success(endpoint, body, is_json)
+        if !is_json
+          raise HTTPError,
+                "Received a success response for #{endpoint} but it is not JSON: #{body}"
+        end
 
-      JSON.parse(body)
+        JSON.parse(body)
+      end
     end
   end
 end