maxmind-geoip2 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f724b0db8ed7f0700617ba0d37cb08e0b1b10a4ed04d2a59bd8538451d503ffb
-  data.tar.gz: 172ce815ec47fc1ea64350c9ae5a14880c77a11f429e5a3a7e2bda649903b634
+  metadata.gz: 2825710c836cdc4f085ac2e89f88753aa972124ac307af9669866bb355c61f10
+  data.tar.gz: c420943be58fd25b84afe0a51264333c4ef268259da7946b58cd7ef77dd8a46b
 SHA512:
-  metadata.gz: ac670d5d555b89fd01fbc638ba32f25cb884c6d138ff60154661bcd75197a2f583f243a5431ae19d137752a4077d4ff160c0132c293428d9764e55c3aeee2b4b
-  data.tar.gz: add54d450ec8f3d5440fb329bc6cd0299b70eb204fdf8b9d2fdec5338a487efe11f917a5630e5a7b02de498078015746deaa13a835823621c70699d44d5b0321
+  metadata.gz: 30d7e6caeaeded96d60fb981bcc2c4ce518620e973f3dae47433cd1582265fa315706a826c1bc62d29dfce013d5cee78ab1fefff54f51ef858589a54075b24f0
+  data.tar.gz: ca89534bc5f0572ad5b69c7c7b92be70089d6e7e600f962d71a38c8c073299d01ed141c6b1b5089cbca9694c6f49b5b8bcb77a45fb1d2ab668cf3f698c40abdb

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 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

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'] # 美国
 

data/lib/maxmind/geoip2/client.rb

@@ -68,7 +68,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.
@@ -111,7 +113,7 @@ module MaxMind
       end
       # 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
@@ -148,7 +150,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
@@ -185,7 +187,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
@@ -240,11 +245,11 @@ 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
 
         proxy

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.
       #

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

@@ -13,7 +13,7 @@ module MaxMind
         # @!visibility private
         def initialize(record)
           super(record)
-          if !record.key?('network') && record.key?('ip_address') &&
+          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
@@ -69,7 +69,7 @@ module MaxMind
         # NAT, this may differ from the IP address locally assigned to it. This
         # attribute is returned by all end points.
         #
-        # @return [String]
+        # @return [String, nil]
         def ip_address
           get('ip_address')
         end
@@ -149,7 +149,7 @@ module MaxMind
         # this is the largest network where all of the fields besides ip_address
         # have the same value.
         #
-        # @return [String]
+        # @return [String, nil]
         def network
           get('network')
         end

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     = '0.5.0'
+  s.version     = '0.6.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'
@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.licenses    = ['Apache-2.0', 'MIT']
   s.metadata = {
     'bug_tracker_uri' => 'https://github.com/maxmind/GeoIP2-ruby/issues',
-    'changelog_uri' => 'https://github.com/maxmind/GeoIP2-ruby/blob/master/CHANGELOG.md',
+    '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',
     'source_code_uri' => 'https://github.com/maxmind/GeoIP2-ruby',

data/test/test_client.rb

@@ -339,12 +339,12 @@ class ClientTest < Minitest::Test
         status: 400,
       },
       '1.2.3.71' => {
-        body: JSON.generate({ 'code': 'HI' }),
+        body: JSON.generate({ code: 'HI' }),
         headers: { 'Content-Type': CONTENT_TYPES[:country] },
         status: 400,
       },
       '1.2.3.8' => {
-        body: JSON.generate({ 'weird': 42 }),
+        body: JSON.generate({ weird: 42 }),
         headers: { 'Content-Type': CONTENT_TYPES[:country] },
         status: 400,
       },

data/test/test_model_country.rb

@@ -77,4 +77,20 @@ class CountryModelTest < Minitest::Test
     model = MaxMind::GeoIP2::Model::Country.new(RAW, ['en'])
     assert_raises(NoMethodError) { model.traits.unknown }
   end
+
+  # This can happen if we're being created from a not fully populated response
+  # when used by minFraud. It shouldn't ever happen from GeoIP2 though.
+  def test_no_traits
+    model = MaxMind::GeoIP2::Model::Country.new(
+      {
+        'continent' => {
+          'code' => 'NA',
+          'geoname_id' => 42,
+          'names' => { 'en' => 'North America' },
+        },
+      },
+      ['en'],
+    )
+    assert_equal(42, model.continent.geoname_id)
+  end
 end

data/test/test_reader.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'ipaddr'
+require 'maxmind/db'
 require 'maxmind/geoip2'
 require 'minitest/autorun'
 
@@ -469,4 +470,49 @@ class ReaderTest < Minitest::Test
     assert_equal('GeoIP2-City', reader.metadata.database_type)
     reader.close
   end
+
+  def test_constructor_with_minimum_keyword_arguments
+    reader = MaxMind::GeoIP2::Reader.new(
+      database: 'test/data/test-data/GeoIP2-Country-Test.mmdb',
+    )
+    record = reader.country('81.2.69.160')
+    assert_equal('United Kingdom', record.country.name)
+    reader.close
+  end
+
+  def test_constructor_with_all_keyword_arguments
+    reader = MaxMind::GeoIP2::Reader.new(
+      database: 'test/data/test-data/GeoIP2-Country-Test.mmdb',
+      locales: %w[ru],
+      mode: MaxMind::DB::MODE_MEMORY,
+    )
+    record = reader.country('81.2.69.160')
+    assert_equal('Великобритания', record.country.name)
+    reader.close
+  end
+
+  def test_constructor_missing_database
+    error = assert_raises(ArgumentError) do
+      MaxMind::GeoIP2::Reader.new
+    end
+    assert_equal('Invalid database parameter', error.message)
+
+    error = assert_raises(ArgumentError) do
+      MaxMind::GeoIP2::Reader.new(
+        locales: %w[ru],
+      )
+    end
+    assert_equal('Invalid database parameter', error.message)
+  end
+
+  def test_old_constructor_parameters
+    reader = MaxMind::GeoIP2::Reader.new(
+      'test/data/test-data/GeoIP2-Country-Test.mmdb',
+      %w[ru],
+      mode: MaxMind::DB::MODE_MEMORY,
+    )
+    record = reader.country('81.2.69.160')
+    assert_equal('Великобритания', record.country.name)
+    reader.close
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maxmind-geoip2
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - William Storey
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-25 00:00:00.000000000 Z
+date: 2021-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -235,7 +235,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/maxmind/GeoIP2-ruby/issues
-  changelog_uri: https://github.com/maxmind/GeoIP2-ruby/blob/master/CHANGELOG.md
+  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
   source_code_uri: https://github.com/maxmind/GeoIP2-ruby