maxmind-geoip2 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 874135d664c0af2e82c184ce30fffbdfe72bb6badc1aa53ee0ec5eba626e5a1d
-  data.tar.gz: 7aec662f3893322c983f647545f4a155b27bda20b7fd6349201fc386264bdc88
+  metadata.gz: 2bdd199c61f9c7116b023d420f1fb0763d05abd7711dd7be0f177113028140ff
+  data.tar.gz: 00a081df1adc640dff12ef5fb8670ac9714b9edd1ef3fa65049033a1fa9d385b
 SHA512:
-  metadata.gz: 3b5d57920b467ccae6144b6f4aca8266721124481917014025390f02f6728138b704513137596593226506f82d554cf77afb215921a13fa8622e1b4e3a4f8b43
-  data.tar.gz: 28be946c7ea163e61b641029f3094de7b47ac2ce8bec6d1c68f9ddd5d084f55419403daeb30762fce3d0346ea0fb083de0d946621f6d659eabe03cafe3c3d0dd
+  metadata.gz: 85a980183be16fa99909d42db32d295ff68a8c718cb31384aef78db8fb287a970d148d12c112fbb9c3cde0a84d396a438a9faf7c196b3e2bfadce93695ebf8e4
+  data.tar.gz: 3ef1e40dd82bbf1acf3ddb14b1d774c246c78219463a00b87bfa46c14af7b623ccdfb9af5046c3a1d0b0b8b18fbe4f575d88d28d9930f3b10913c0035326a611

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 1.1.0 (2021-11-18)
+
+* Exceptions from this gem now inherit from `MaxMind::GeoIP2::Error`. IP
+  address related exceptions now inherit from
+  `MaxMind::GeoIP2::AddressError`, which itself inherits from
+  `MaxMind::GeoIP2::Error`. Pull Request by gr8bit. GitHub #35.
+* Support for mobile country code (MCC) and mobile network codes (MNC) was
+  added for the GeoIP2 ISP and Enterprise databases as well as the GeoIP2
+  City and Insights web services. `mobile_country_code` and
+  `mobile_network_code` attributes were added to
+  `MaxMind::GeoIP2::Model::ISP` for the GeoIP2 ISP database and
+  `MaxMind::GeoIP2::Record::Traits` for the Enterprise database and the
+  GeoIP2 City and Insights web services. We expect this data to be
+  available by late January, 2022.
+
 ## 1.0.0 (2021-05-14)
 
 * Ruby 2.4 is no longer supported. If you're using Ruby 2.4, please use

data/README.md

@@ -2,11 +2,9 @@
 
 ## Description
 
-This is the Ruby API for the GeoIP2
-[webservices](https://dev.maxmind.com/geoip/geoip2/web-services) and
-[databases](https://dev.maxmind.com/geoip/geoip2/geolite2/). This API also
-works with the free [GeoLite2
-databases](https://dev.maxmind.com/geoip/geoip2/geolite2/).
+This is the Ruby API for the GeoIP2 and GeoLite2
+[webservices](https://dev.maxmind.com/geoip/docs/web-services?lang=en)
+and [databases](https://dev.maxmind.com/geoip/docs/databases?lang=en).
 
 ## Installation
 
@@ -282,7 +280,7 @@ 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/geoip2/web-services) for details on
+docs](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`

data/lib/maxmind/geoip2/client.rb

@@ -11,7 +11,7 @@ require 'maxmind/geoip2/model/insights'
 module MaxMind
   module GeoIP2
     # This class provides a client API for all the
-    # {https://dev.maxmind.com/geoip/geoip2/web-services/ GeoIP2 Precision web
+    # {https://dev.maxmind.com/geoip/docs/web-services?lang=en 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.

data/lib/maxmind/geoip2/errors.rb

@@ -2,40 +2,49 @@
 
 module MaxMind
   module GeoIP2
+    # Module's base error class
+    class Error < StandardError
+    end
+
+    # Base error class for all errors that originate from the IP address
+    # itself and will not change when retried.
+    class AddressError < Error
+    end
+
     # An AddressNotFoundError means the IP address was not found in the
     # database or the web service said the IP address was not found.
-    class AddressNotFoundError < RuntimeError
+    class AddressNotFoundError < AddressError
     end
 
     # An HTTPError means there was an unexpected HTTP status or response.
-    class HTTPError < RuntimeError
+    class HTTPError < Error
     end
 
     # An AddressInvalidError means the IP address was invalid.
-    class AddressInvalidError < RuntimeError
+    class AddressInvalidError < AddressError
     end
 
     # An AddressReservedError means the IP address is reserved.
-    class AddressReservedError < RuntimeError
+    class AddressReservedError < AddressError
     end
 
     # An AuthenticationError means there was a problem authenticating to the
     # web service.
-    class AuthenticationError < RuntimeError
+    class AuthenticationError < Error
     end
 
     # An InsufficientFundsError means the account is out of credits.
-    class InsufficientFundsError < RuntimeError
+    class InsufficientFundsError < Error
     end
 
     # A PermissionRequiredError means the account does not have permission to
     # use the requested service.
-    class PermissionRequiredError < RuntimeError
+    class PermissionRequiredError < Error
     end
 
     # An InvalidRequestError means the web service returned an error and there
     # is no more specific error class.
-    class InvalidRequestError < RuntimeError
+    class InvalidRequestError < Error
     end
   end
 end

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

@@ -14,7 +14,7 @@ module MaxMind
       #
       # 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/geoip2/web-services for more details.
+      # https://dev.maxmind.com/geoip/docs/web-services?lang=en for more details.
       #
       # See {MaxMind::GeoIP2::Model::Country} for inherited methods.
       class City < Country

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

@@ -9,7 +9,7 @@ module MaxMind
       #
       # 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/geoip2/web-services for more details.
+      # 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

@@ -10,7 +10,7 @@ module MaxMind
       #
       # 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/geoip2/web-services for more details.
+      # https://dev.maxmind.com/geoip/docs/web-services?lang=en for more details.
       class Insights < City
       end
     end

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

@@ -36,6 +36,22 @@ module MaxMind
           get('isp')
         end
 
+        # The {https://en.wikipedia.org/wiki/Mobile_country_code mobile country
+        # code (MCC)} associated with the IP address and ISP.
+        #
+        # @return [String, nil]
+        def mobile_country_code
+          get('mobile_country_code')
+        end
+
+        # The {https://en.wikipedia.org/wiki/Mobile_country_code mobile network
+        # code (MNC)} associated with the IP address and ISP.
+        #
+        # @return [String, nil]
+        def mobile_network_code
+          get('mobile_network_code')
+        end
+
         # The network in CIDR notation associated with the record. In particular,
         # this is the largest network where all of the fields besides ip_address
         # have the same value.

data/lib/maxmind/geoip2/reader.rb

@@ -37,8 +37,7 @@ module MaxMind
       # Reader and reuse it.
       #
       # Once created, the Reader is safe to use for lookups from multiple
-      # 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.
+      # threads. It is safe to use after forking.
       #
       # @overload initialize(database:, locales: ['en'], mode: MaxMind::DB::MODE_AUTO)
       #   @param database [String] a path to a GeoIP2/GeoLite2 database file.

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

@@ -16,9 +16,7 @@ module MaxMind
           if record && !record.key?('network') && record.key?('ip_address') &&
              record.key?('prefix_length')
             ip = IPAddr.new(record['ip_address']).mask(record['prefix_length'])
-            # We could use ip.prefix instead of record['prefix_length'], but that
-            # method only becomes available in Ruby 2.5+.
-            record['network'] = format('%s/%d', ip.to_s, record['prefix_length'])
+            record['network'] = format('%s/%d', ip.to_s, ip.prefix)
           end
         end
 
@@ -111,6 +109,28 @@ module MaxMind
           get('is_legitimate_proxy')
         end
 
+        # The {https://en.wikipedia.org/wiki/Mobile_country_code mobile country
+        # code (MCC)} associated with the IP address and ISP.
+        #
+        # This attribute is only available from the City and Insights web service
+        # and the GeoIP2 Enterprise database.
+        #
+        # @return [String, nil]
+        def mobile_country_code
+          get('mobile_country_code')
+        end
+
+        # The {https://en.wikipedia.org/wiki/Mobile_country_code mobile network
+        # code (MNC)} associated with the IP address and ISP.
+        #
+        # This attribute is only available from the City and Insights web service
+        # and the GeoIP2 Enterprise database.
+        #
+        # @return [String, nil]
+        def mobile_network_code
+          get('mobile_network_code')
+        end
+
         # This is true if the IP address belongs to a public proxy. This property
         # is only available from GeoIP2 Precision Insights.
         #

data/maxmind-geoip2.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |s|
   s.files       = Dir['**/*']
   s.name        = 'maxmind-geoip2'
   s.summary     = 'A gem for interacting with the GeoIP2 webservices and databases.'
-  s.version     = '1.0.0'
+  s.version     = '1.1.0'
 
   s.description = 'A gem for interacting with the GeoIP2 webservices and databases. MaxMind provides geolocation data as downloadable databases as well as through a webservice.'
   s.email = 'support@maxmind.com'
@@ -16,6 +16,7 @@ Gem::Specification.new do |s|
     'changelog_uri' => 'https://github.com/maxmind/GeoIP2-ruby/blob/main/CHANGELOG.md',
     'documentation_uri' => 'https://www.rubydoc.info/gems/maxmind-geoip2',
     'homepage_uri' => 'https://github.com/maxmind/GeoIP2-ruby',
+    'rubygems_mfa_required' => 'true',
     'source_code_uri' => 'https://github.com/maxmind/GeoIP2-ruby',
   }
   s.required_ruby_version = '>= 2.5.0'

data/test/data/MaxMind-DB-spec.md

@@ -26,9 +26,10 @@ not be broken by minor version changes to the format.
 The binary database is split into three parts:
 
 1. The binary search tree. Each level of the tree corresponds to a single bit
-in the 128 bit representation of an IPv6 address.
-2. The data section. These are the values returned to the client for a
-specific IP address, e.g. "US", "New York", or a more complex map type made up
+in the prefix of the network the IP address belongs to.
+2. The data section with the values for the networks in the binary search
+tree. These values may be comprised of a single data type, e.g., the string
+"US" or "New York", or they may be a more complex map or array type made up
 of multiple fields.
 3. Database metadata. Information about the database itself.
 
@@ -48,15 +49,15 @@ of this sequence.
 The maximum allowable size for the metadata section, including the marker that
 starts the metadata, is 128KiB.
 
-The metadata is stored as a map data structure. This structure is described
-later in the spec. Changing a key's data type or removing a key would
-constitute a major version change for this spec.
+The metadata is stored as a separate data section comprised of a map data
+structure starting at the beginning of that section. This structure is
+described later in the spec.
 
 Except where otherwise specified, each key listed is required for the database
 to be considered valid.
 
-Adding a key constitutes a minor version change. Removing a key or changing
-its type constitutes a major version change.
+Changing a key's data type or removing a key would constitute a major version
+change for this spec. Adding a key constitutes a minor version change.
 
 The list of known keys for the current version of the format is as follows:
 
@@ -304,7 +305,8 @@ will point to the beginning of a field. It is illegal for a pointer to point
 to another pointer.
 
 Pointer values start from the beginning of the data section, *not* the
-beginning of the file.
+beginning of the file. Pointers in the metadata start from the beginning of
+the metadata section.
 
 ### UTF-8 string - 2
 
@@ -337,8 +339,10 @@ by the length specifier in the control byte. See below for details.
 
 A length of zero always indicates the number 0.
 
-When storing a signed integer, the left-most bit is the sign. A 1 is negative
-and a 0 is positive.
+When storing a signed integer, fields shorter than the maximum byte length
+are always positive. When the field is the maximum length, e.g., 4 bytes for
+32-bit integers, the left-most bit is the sign. A 1 is negative and a 0 is
+positive.
 
 The type numbers for our integer types are: