maxmind-geoip2 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bdd199c61f9c7116b023d420f1fb0763d05abd7711dd7be0f177113028140ff
-  data.tar.gz: 00a081df1adc640dff12ef5fb8670ac9714b9edd1ef3fa65049033a1fa9d385b
+  metadata.gz: 9d6ddb183c97df1041a902a1f2f98dec87e640b5907ae19b080bdd03c87bc03f
+  data.tar.gz: 8f0e58e55e605576bc4214e878c28aaab3bb6c0dbd065bb1281ac5f0db65e69e
 SHA512:
-  metadata.gz: 85a980183be16fa99909d42db32d295ff68a8c718cb31384aef78db8fb287a970d148d12c112fbb9c3cde0a84d396a438a9faf7c196b3e2bfadce93695ebf8e4
-  data.tar.gz: 3ef1e40dd82bbf1acf3ddb14b1d774c246c78219463a00b87bfa46c14af7b623ccdfb9af5046c3a1d0b0b8b18fbe4f575d88d28d9930f3b10913c0035326a611
+  metadata.gz: 2c6d5e20fd3bef3aacde30acb0c22695c8a903626747db02b58067adcaeafd9d2673f9be8189fad8d6a53869028ff15bf9536ce66a435a2da6e86fb4126cf06b
+  data.tar.gz: 8c79484d19313833856f91deabceed833f2dae00fb1cd4993d57b973b1747541cf83122e07043c1b4925a2f291172195ab024988be39501a922a751c7808cde1

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## 1.3.0 (2025-05-06)
+
+* Support for the GeoIP Anonymous Plus database has been added. To do a
+  lookup in this database, use the `anonymous_plus` method on
+  `MaxMind::GeoIP2::Reader`.
+* Ruby 3.0+ is now required. If you're using Ruby 2.5, 2.6, or 2.7, please
+  use version 1.2.0 of this gem.
+* Deprecated `metro_code` on `MaxMind::GeoIP2::Record::Location`. The code
+  values are no longer being maintained.
+
+## 1.2.0 (2023-12-04)
+
+* `MaxMind::GeoIP2::Client` now validates the IP address before making a
+  request to the web service.
+* `MaxMind::GeoIP2::Client` now includes the version of Ruby, the version
+  of the HTTP client library, and its own version in the User-Agent header.
+* The `anycast?` method was added to `MaxMind::GeoIP2::Record::Traits`.
+  This returns `true` if the IP address belongs to an [anycast
+  network](https://en.wikipedia.org/wiki/Anycast). This is available for
+  the GeoIP2 Country, City Plus, and Insights web services and the GeoIP2
+  Country, City, and Enterprise databases.
+
 ## 1.1.0 (2021-11-18)
 
 * Exceptions from this gem now inherit from `MaxMind::GeoIP2::Error`. IP

data/Gemfile.lock

@@ -0,0 +1,114 @@
+PATH
+  remote: .
+  specs:
+    maxmind-geoip2 (1.3.0)
+      connection_pool (~> 2.2)
+      http (>= 4.3, < 6.0)
+      maxmind-db (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.3)
+    base64 (0.2.0)
+    bigdecimal (3.1.9)
+    connection_pool (2.5.3)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    domain_name (0.6.20240107)
+    ffi (1.17.2)
+    ffi (1.17.2-aarch64-linux-gnu)
+    ffi (1.17.2-aarch64-linux-musl)
+    ffi (1.17.2-arm-linux-gnu)
+    ffi (1.17.2-arm-linux-musl)
+    ffi (1.17.2-arm64-darwin)
+    ffi (1.17.2-x86-linux-gnu)
+    ffi (1.17.2-x86-linux-musl)
+    ffi (1.17.2-x86_64-darwin)
+    ffi (1.17.2-x86_64-linux-gnu)
+    ffi (1.17.2-x86_64-linux-musl)
+    ffi-compiler (1.3.2)
+      ffi (>= 1.15.5)
+      rake
+    hashdiff (1.1.2)
+    http (5.2.0)
+      addressable (~> 2.8)
+      base64 (~> 0.1)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      llhttp-ffi (~> 0.5.0)
+    http-cookie (1.0.8)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    json (2.11.3)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    llhttp-ffi (0.5.1)
+      ffi-compiler (~> 1.0)
+      rake (~> 13.0)
+    maxmind-db (1.3.2)
+    minitest (5.25.5)
+    parallel (1.27.0)
+    parser (3.3.8.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.4.0)
+    public_suffix (6.0.2)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.10.0)
+    rexml (3.4.1)
+    rubocop (1.75.5)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.44.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-performance (1.25.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    webmock (3.25.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  ruby
+  x86-linux-gnu
+  x86-linux-musl
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  maxmind-geoip2!
+  minitest
+  rake
+  rubocop
+  rubocop-performance
+  webmock
+
+BUNDLED WITH
+   2.6.7

data/README.dev.md

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

data/README.md

@@ -133,6 +133,21 @@ record = reader.anonymous_ip('128.101.101.101')
 puts "Anonymous" if record.is_anonymous
 ```
 
+### Anonymous Plus Example
+
+```ruby
+require 'maxmind/geoip2'
+
+# This creates the Reader object which should be reused across lookups.
+reader = MaxMind::GeoIP2::Reader.new(
+  database: '/usr/share/GeoIP/GeoIP-Anonymous-Plus.mmdb',
+)
+
+record = reader.anonymous_plus('128.101.101.101')
+
+puts record.anonymizer_confidence # 30
+```
+
 ### ASN Example
 
 ```ruby
@@ -228,14 +243,19 @@ client = MaxMind::GeoIP2::Client.new(
   account_id: 42,
   license_key: 'license_key',
 
-  # To use the GeoLite2 web service instead of GeoIP2 Precision, set
+  # To use the GeoLite2 web service instead of the GeoIP2 web service, set
   # the host parameter to "geolite.info":
   # host: 'geolite.info',
+
+  # To use the Sandbox GeoIP2 web service instead of the production GeoIP2
+  # web service, set the host parameter to "sandbox.maxmind.com":
+  # host: 'sandbox.maxmind.com',
 )
 
 # Replace "city" with the method corresponding to the web service that
 # you are using, e.g., "country", "insights". Please note that Insights
-# is only supported by GeoIP2 Precision and not the GeoLite2 web service.
+# is only supported by the GeoIP2 web service and not the GeoLite2 web
+# service.
 record = client.city('128.101.101.101')
 
 puts record.country.iso_code # US
@@ -279,8 +299,8 @@ which can be populated vary between end points. In addition, while an end
 point may offer a particular piece of data, MaxMind does not always have
 every piece of data for any given IP address.
 
-See the [GeoIP2 Precision web service
-docs](https://dev.maxmind.com/geoip/docs/web-services?lang=en) for details on
+See the [GeoIP2 web service
+documentation](https://dev.maxmind.com/geoip/docs/web-services?lang=en) for details on
 what data each end point may return.
 
 The only piece of data which is always returned is the `ip_address`
@@ -327,7 +347,7 @@ client API, please see [our support page](https://www.maxmind.com/en/support).
 
 ## Requirements
 
-This code requires Ruby version 2.5 or higher.
+This code requires Ruby version 3.0 or higher.
 
 ## Contributing
 
@@ -340,7 +360,7 @@ This library uses [Semantic Versioning](https://semver.org/).
 
 ## Copyright and License
 
-This software is Copyright (c) 2020-2021 by MaxMind, Inc.
+This software is Copyright (c) 2020-2025 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/Rakefile

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'rubocop/rake_task'
 

data/lib/maxmind/geoip2/client.rb

@@ -4,15 +4,17 @@ require 'connection_pool'
 require 'http'
 require 'json'
 require 'maxmind/geoip2/errors'
+require 'maxmind/geoip2/version'
 require 'maxmind/geoip2/model/city'
 require 'maxmind/geoip2/model/country'
 require 'maxmind/geoip2/model/insights'
+require 'resolv'
 
 module MaxMind
   module GeoIP2
     # This class provides a client API for all the
-    # {https://dev.maxmind.com/geoip/docs/web-services?lang=en GeoIP2 Precision web
-    # services}. The services are Country, City, and Insights. Each service
+    # {https://dev.maxmind.com/geoip/docs/web-services?lang=en GeoIP2 web
+    # services}. The services are Country, City Plus, and Insights. Each service
     # returns a different set of data about an IP address, with Country returning
     # the least data and Insights the most.
     #
@@ -58,7 +60,7 @@ module MaxMind
       # rubocop:disable Metrics/CyclomaticComplexity
       # rubocop:disable Metrics/PerceivedComplexity
 
-      # Create a Client that may be used to query a GeoIP2 Precision web service.
+      # Create a Client that may be used to query a GeoIP2 web service.
       #
       # Once created, the Client is safe to use for lookups from multiple
       # threads.
@@ -71,8 +73,10 @@ module MaxMind
       #   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.
+      #   this to "geolite.info" to use the GeoLite2 web service instead of the
+      #   GeoIP2 web service. Set this to "sandbox.maxmind.com" to use the
+      #   Sandbox environment. The sandbox allows you to experiment with the
+      #   API without affecting your production data.
       #
       # @param timeout [Integer] the number of seconds to wait for a request
       #   before timing out. If 0, no timeout is set.
@@ -117,7 +121,7 @@ module MaxMind
       # rubocop:enable Metrics/CyclomaticComplexity
       # rubocop:enable Metrics/ParameterLists
 
-      # This method calls the City web service.
+      # This method calls the City Plus 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
@@ -193,8 +197,8 @@ module MaxMind
 
       # 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.
+      # Insights is only supported by the GeoIP2 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
@@ -234,6 +238,10 @@ module MaxMind
       private
 
       def response_for(endpoint, model_class, ip_address)
+        if ip_address != 'me' && ip_address !~ Resolv::AddressRegex
+          raise AddressInvalidError, "The value \"#{ip_address}\" is not a valid IP address"
+        end
+
         record = get(endpoint, ip_address)
 
         model_class.new(record, @locales)
@@ -243,8 +251,9 @@ module MaxMind
         headers = HTTP.basic_auth(user: @account_id, pass: @license_key)
                       .headers(
                         accept: 'application/json',
-                        user_agent: 'MaxMind-GeoIP2-ruby',
+                        user_agent: "MaxMind-GeoIP2-ruby/#{VERSION} ruby/#{RUBY_VERSION} http/#{HTTP::VERSION}"
                       )
+
         timeout = @timeout > 0 ? headers.timeout(@timeout) : headers
 
         proxy = timeout

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'maxmind/geoip2/model/anonymous_ip'
+
+module MaxMind
+  module GeoIP2
+    module Model
+      # Model class for the Anonymous Plus database.
+      class AnonymousPlus < AnonymousIP
+        # A score ranging from 1 to 99 that is our percent confidence that the
+        # network is currently part of an actively used VPN service.
+        #
+        # @return [Integer, nil]
+        def anonymizer_confidence
+          get('anonymizer_confidence')
+        end
+
+        # The last day that the network was sighted in our analysis of
+        # anonymized networks. This value is parsed lazily.
+        #
+        # @return [Date, nil] A Date object representing the last seen date,
+        #   or nil if the date is not available.
+        def network_last_seen
+          return @network_last_seen if defined?(@network_last_seen)
+
+          date_string = get('network_last_seen')
+
+          if !date_string
+            return nil
+          end
+
+          @network_last_seen = Date.parse(date_string)
+        end
+
+        # The name of the VPN provider (e.g., NordVPN, SurfShark, etc.)
+        # associated with the network.
+        #
+        # @return [String, nil]
+        def provider_name
+          get('provider_name')
+        end
+      end
+    end
+  end
+end

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

@@ -9,12 +9,11 @@ require 'maxmind/geoip2/record/subdivision'
 module MaxMind
   module GeoIP2
     module Model
-      # Model class for the data returned by the GeoIP2 City web service and
-      # database. It is also used for GeoLite2 City lookups.
+      # Model class for the data returned by the GeoIP2 City Plus web service
+      # and the City database. It is also used for GeoLite2 City lookups.
       #
-      # The only difference between the City and Insights model classes is which
-      # fields in each record may be populated. See
-      # https://dev.maxmind.com/geoip/docs/web-services?lang=en for more details.
+      # See https://dev.maxmind.com/geoip/docs/web-services?lang=en for more
+      # details.
       #
       # See {MaxMind::GeoIP2::Model::Country} for inherited methods.
       class City < Country
@@ -47,7 +46,7 @@ module MaxMind
 
         # @!visibility private
         def initialize(record, locales)
-          super(record, locales)
+          super
           @city = MaxMind::GeoIP2::Record::City.new(record['city'], locales)
           @location = MaxMind::GeoIP2::Record::Location.new(record['location'])
           @postal = MaxMind::GeoIP2::Record::Postal.new(record['postal'])

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

@@ -7,8 +7,9 @@ module MaxMind
     module Model
       # Model class for the GeoIP2 Connection Type database.
       class ConnectionType < Abstract
-        # The connection type may take the following values: "Dialup", "Cable/DSL",
-        # "Corporate", "Cellular". Additional values may be added in the future.
+        # The connection type may take the following values: "Dialup",
+        # "Cable/DSL", "Corporate", "Cellular", and "Satellite". Additional
+        # values may be added in the future.
         #
         # @return [String, nil]
         def connection_type

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

@@ -7,9 +7,8 @@ module MaxMind
     module Model
       # Model class for the data returned by GeoIP2 Enterprise database lookups.
       #
-      # The only difference between the City and Insights model classes is which
-      # fields in each record may be populated. See
-      # https://dev.maxmind.com/geoip/docs/web-services?lang=en for more details.
+      # See https://dev.maxmind.com/geoip/docs/web-services?lang=en for more
+      # details.
       #
       # See {MaxMind::GeoIP2::Model::City} for inherited methods.
       class Enterprise < City

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

@@ -5,12 +5,10 @@ require 'maxmind/geoip2/model/city'
 module MaxMind
   module GeoIP2
     module Model
-      # Model class for the data returned by the GeoIP2 Precision Insights web
-      # service.
+      # Model class for the data returned by the GeoIP2 Insights web service.
       #
-      # The only difference between the City and Insights model classes is which
-      # fields in each record may be populated. See
-      # https://dev.maxmind.com/geoip/docs/web-services?lang=en for more details.
+      # See https://dev.maxmind.com/geoip/docs/web-services?lang=en for more
+      # details.
       class Insights < City
       end
     end

data/lib/maxmind/geoip2/reader.rb

@@ -3,6 +3,7 @@
 require 'maxmind/db'
 require 'maxmind/geoip2/errors'
 require 'maxmind/geoip2/model/anonymous_ip'
+require 'maxmind/geoip2/model/anonymous_plus'
 require 'maxmind/geoip2/model/asn'
 require 'maxmind/geoip2/model/city'
 require 'maxmind/geoip2/model/connection_type'
@@ -86,7 +87,7 @@ module MaxMind
       # rubocop:enable Metrics/CyclomaticComplexity
       # rubocop:enable Metrics/PerceivedComplexity
 
-      # Look up the IP address in the database.
+      # Look up the IP address in the Anonymous IP database.
       #
       # @param ip_address [String] a string in the standard notation. It may be
       #   IPv4 or IPv6.
@@ -110,6 +111,30 @@ module MaxMind
         )
       end
 
+      # Look up the IP address in the Anonymous Plus database.
+      #
+      # @param ip_address [String] a string in the standard notation. It may be
+      #   IPv4 or IPv6.
+      #
+      # @return [MaxMind::GeoIP2::Model::AnonymousPlus]
+      #
+      # @raise [ArgumentError] if used against a non-Anonymous Plus database
+      #   or if you attempt to look up an IPv6 address in an IPv4 only database.
+      #
+      # @raise [AddressNotFoundError] if the IP address is not found in the
+      #   database.
+      #
+      # @raise [MaxMind::DB::InvalidDatabaseError] if the database appears
+      #   corrupt.
+      def anonymous_plus(ip_address)
+        flat_model_for(
+          Model::AnonymousPlus,
+          'anonymous_plus',
+          'GeoIP-Anonymous-Plus',
+          ip_address,
+        )
+      end
+
       # Look up the IP address in an ASN database.
       #
       # @param ip_address [String] a string in the standard notation. It may be

data/lib/maxmind/geoip2/record/location.rb

@@ -46,11 +46,11 @@ module MaxMind
           get('longitude')
         end
 
-        # The metro code of the location if the location is in the US. MaxMind
-        # returns the same metro codes as the Google AdWords API. See
-        # https://developers.google.com/adwords/api/docs/appendix/cities-DMAregions.
+        # The metro code is a no-longer-maintained code for targeting
+        # advertisements in Google.
         #
         # @return [Integer, nil]
+        # @deprecated Code values are no longer maintained.
         def metro_code
           get('metro_code')
         end