maxmind-geoip2 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1a002f3e88bfdcee342f01131f73efbb7d22263e
-  data.tar.gz: c84ca6ebd6460ff4e9e5a449198be9bd4a6cfe1e
+SHA256:
+  metadata.gz: 59a52bbdfb71c9b0ebe0104616db7425e90f166940aa14a04aef3baa60adce7e
+  data.tar.gz: 51a5b6921967659ac3ee2a874b7625065b71102ce8fc5ee05b0ea7b94f34f233
 SHA512:
-  metadata.gz: 67ef5b0bbef11189d028619f8f9543eefd270e0a4d09ce9b5c7447ccd1987438e034bf0b0394cef815dbc3ae919cfa7fa54829bbba45351a897c6828df9547cb
-  data.tar.gz: 4f4fef06fa1d74c670e562aeca1a01eb41786af8130519270d500c72ebd93afb84038ed54e34ead1ea08e6b98828b62f3aeb1a5cffa40170db3a523d651647b5
+  metadata.gz: 3a75b0ac6a4da68a4c79b9a8b3a61d45c458279189edb5dc98a5366c4dbac567d6834528c6060ad3dbb759316614649b0d8d9bdf571516ca5d33d639dbf7f76c
+  data.tar.gz: dfa9fb9b9d1f0a10194ee80b4860cd2b83398fbdc86f042a3e9bcf0c90bd4d7621323524167f19467d46faf94bd790283d5ffdb14d8ba66841615dea4d64c37e

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.1.0 (2020-02-20)
+
+* Added support for the Anonymous IP, ASN, Connection Type, Domain, and ISP
+  databases.
+* Added missing dependency on maxmind-db to the gemspec. Reported by Sean
+  Dilda. GitHub #4.
+
 ## 0.0.1 (2020-01-09)
 
 * Initial implementation with support for location databases.

data/Gemfile.lock

@@ -4,23 +4,25 @@ GEM
     ast (2.4.0)
     jaro_winkler (1.5.4)
     maxmind-db (1.1.0)
-    minitest (5.13.0)
+    minitest (5.14.0)
     parallel (1.19.1)
     parser (2.7.0.2)
       ast (~> 2.4.0)
     rainbow (3.0.0)
     rake (13.0.1)
-    rubocop (0.79.0)
+    rexml (3.2.4)
+    rubocop (0.80.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      rexml
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
     rubocop-performance (1.5.2)
       rubocop (>= 0.71.0)
     ruby-progressbar (1.10.1)
-    unicode-display_width (1.6.0)
+    unicode-display_width (1.6.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -114,6 +114,75 @@ puts record.location.longitude # -93.2323
 puts record.traits.network # 128.101.101.101/32
 ```
 
+### Anonymous IP Example
+
+```ruby
+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')
+
+record = reader.anonymous_ip('128.101.101.101')
+
+puts "Anonymous" if record.is_anonymous
+```
+
+### ASN Example
+
+```ruby
+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')
+
+record = reader.asn('128.101.101.101')
+
+puts record.autonomous_system_number # 1234
+puts record.autonomous_system_organization # Example Ltd
+```
+
+### Connection Type Example
+
+```ruby
+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')
+
+record = reader.connection_type('128.101.101.101')
+
+puts record.connection_type # Cable/DSL
+```
+
+### Domain Example
+
+```ruby
+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')
+
+record = reader.domain('128.101.101.101')
+
+puts record.domain # example.com
+```
+
+### ISP Example
+
+```ruby
+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')
+
+record = reader.isp('128.101.101.101')
+
+puts record.autonomous_system_number # 217
+puts record.autonomous_system_organization # University of Minnesota
+puts record.isp # University of Minnesota
+puts record.organization # University of Minnesota
+```
+
 ## Values to use for Database or Array Keys
 
 **We strongly discourage you from using a value from any `names` property

data/lib/maxmind/geoip2.rb

@@ -1,16 +1,3 @@
 # frozen_string_literal: true
 
 require 'maxmind/geoip2/reader'
-
-# rubocop:disable Style/ClassAndModuleChildren
-# :nodoc: all
-module MaxMind
-  module GeoIP2
-    module Record # :nodoc:
-    end
-
-    module Model # :nodoc:
-    end
-  end
-end
-# rubocop:enable Style/ClassAndModuleChildren

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'ipaddr'
+
+module MaxMind::GeoIP2::Model
+  # @!visibility private
+  class Abstract
+    def initialize(record)
+      @record = record
+
+      ip = IPAddr.new(record['ip_address']).mask(record['prefix_length'])
+      record['network'] = format('%s/%d', ip.to_s, record['prefix_length'])
+    end
+
+    protected
+
+    def get(key)
+      if @record.nil? || !@record.key?(key)
+        return false if key.start_with?('is_')
+
+        return nil
+      end
+
+      @record[key]
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'maxmind/geoip2/model/abstract'
+
+module MaxMind::GeoIP2::Model
+  # Model class for the Anonymous IP database.
+  class AnonymousIP < Abstract
+    # This is true if the IP address belongs to any sort of anonymous network.
+    #
+    # @return [Boolean]
+    def anonymous?
+      get('is_anonymous')
+    end
+
+    # This is true if the IP address is registered to an anonymous VPN
+    # provider. If a VPN provider does not register subnets under names
+    # associated with them, we will likely only flag their IP ranges using the
+    # is_hosting_provider attribute.
+    #
+    # @return [Boolean]
+    def anonymous_vpn?
+      get('is_anonymous_vpn')
+    end
+
+    # This is true if the IP address belongs to a hosting or VPN provider (see
+    # description of the is_anonymous_vpn attribute).
+    #
+    # @return [Boolean]
+    def hosting_provider?
+      get('is_hosting_provider')
+    end
+
+    # The IP address that the data in the model is for.
+    #
+    # @return [String]
+    def ip_address
+      get('ip_address')
+    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.
+    #
+    # @return [String]
+    def network
+      get('network')
+    end
+
+    # This is true if the IP address belongs to a public proxy.
+    #
+    # @return [Boolean]
+    def public_proxy?
+      get('is_public_proxy')
+    end
+
+    # This is true if the IP address is a Tor exit node.
+    #
+    # @return [Boolean]
+    def tor_exit_node?
+      get('is_tor_exit_node')
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'maxmind/geoip2/model/abstract'
+
+module MaxMind::GeoIP2::Model
+  # Model class for the GeoLite2 ASN database.
+  class ASN < Abstract
+    # The autonomous system number associated with the IP address.
+    #
+    # @return [Integer, nil]
+    def autonomous_system_number
+      get('autonomous_system_number')
+    end
+
+    # The organization associated with the registered autonomous system number
+    # for the IP address.
+    #
+    # @return [String, nil]
+    def autonomous_system_organization
+      get('autonomous_system_organization')
+    end
+
+    # The IP address that the data in the model is for.
+    #
+    # @return [String]
+    def ip_address
+      get('ip_address')
+    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.
+    #
+    # @return [String]
+    def network
+      get('network')
+    end
+  end
+end

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

@@ -14,26 +14,37 @@ module MaxMind::GeoIP2::Model
   # fields in each record may be populated. See
   # https://dev.maxmind.com/geoip/geoip2/web-services for more details.
   #
-  # See Country for inherited methods.
+  # See {MaxMind::GeoIP2::Model::Country} for inherited methods.
   class City < Country
-    # City data for the IP address. See MaxMind::GeoIP2::Record::City.
+    # City data for the IP address.
+    #
+    # @return [MaxMind::GeoIP2::Record::City]
     attr_reader :city
 
-    # Location data for the IP address. See MaxMind::GeoIP2::Record::Location.
+    # Location data for the IP address.
+    #
+    # @return [MaxMind::GeoIP2::Record::Location]
     attr_reader :location
 
-    # Postal data for the IP address. See MaxMind::GeoIP2::Record::Postal.
+    # Postal data for the IP address.
+    #
+    # @return [MaxMind::GeoIP2::Record::Postal]
     attr_reader :postal
 
-    # An array of MaxMind::GeoIP2::Record::Subdivision objects representing the
-    # country subdivisions for the IP address. The number and type of
-    # subdivisions varies by country, but a subdivision is typically a state,
-    # province, country, etc. Subdivisions are ordered from most general
-    # (largest) to most specific (smallest). If the response did not contain
-    # any subdivisions, this attribute will be an empty array.
+    # The country subdivisions for the IP address.
+    #
+    # The number and type of subdivisions varies by country, but a subdivision
+    # is typically a state, province, country, etc. Subdivisions are ordered
+    # from most general (largest) to most specific (smallest).
+    #
+    # If the response did not contain any subdivisions, this attribute will be
+    # an empty array.
+    #
+    # @return [Array<MaxMind::GeoIP2::Record::Subdivision>]
     attr_reader :subdivisions
 
-    def initialize(record, locales) # :nodoc:
+    # @!visibility private
+    def initialize(record, locales)
       super(record, locales)
       @city = MaxMind::GeoIP2::Record::City.new(record['city'], locales)
       @location = MaxMind::GeoIP2::Record::Location.new(record['location'])
@@ -41,8 +52,12 @@ module MaxMind::GeoIP2::Model
       @subdivisions = create_subdivisions(record['subdivisions'], locales)
     end
 
-    # Return an object representing the most specific subdivision returned. If
-    # the response did not contain any subdivisions, this method returns nil.
+    # The most specific subdivision returned.
+    #
+    # If the response did not contain any subdivisions, this method returns
+    # nil.
+    #
+    # @return [MaxMind::GeoIP2::Record::Subdivision, nil]
     def most_specific_subdivision
       @subdivisions.last
     end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'maxmind/geoip2/model/abstract'
+
+module MaxMind::GeoIP2::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.
+    #
+    # @return [String, nil]
+    def connection_type
+      get('connection_type')
+    end
+
+    # The IP address that the data in the model is for.
+    #
+    # @return [String]
+    def ip_address
+      get('ip_address')
+    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.
+    #
+    # @return [String]
+    def network
+      get('network')
+    end
+  end
+end

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

@@ -9,30 +9,38 @@ module MaxMind::GeoIP2::Model
   # Model class for the data returned by the GeoIP2 Country web service and
   # database. It is also used for GeoLite2 Country lookups.
   class Country
-    # Continent data for the IP address. See MaxMind::GeoIP2::Record::Continent.
+    # Continent data for the IP address.
+    #
+    # @return [MaxMind::GeoIP2::Record::Continent]
     attr_reader :continent
 
     # Country data for the IP address. This object represents the country where
-    # MaxMind believes the end user is located. See
-    # MaxMind::GeoIP2::Record::Country.
+    # MaxMind believes the end user is located.
+    #
+    # @return [MaxMind::GeoIP2::Record::Country]
     attr_reader :country
 
     # Registered country data for the IP address. This record represents the
     # country where the ISP has registered a given IP block and may differ from
-    # the user's country. See MaxMind::GeoIP2::Record::Country.
+    # the user's country.
+    #
+    # @return [MaxMind::GeoIP2::Record::Country]
     attr_reader :registered_country
 
     # Represented country data for the IP address. The represented country is
     # used for things like military bases. It is only present when the
-    # represented country differs from the country. See
-    # MaxMind::GeoIP2::Record::RepresentedCountry.
+    # represented country differs from the country.
+    #
+    # @return [MaxMind::GeoIP2::Record::RepresentedCountry]
     attr_reader :represented_country
 
-    # Data for the traits of the IP address. See
-    # MaxMind::GeoIP2::Record::Traits.
+    # Data for the traits of the IP address.
+    #
+    # @return [MaxMind::GeoIP2::Record::Traits]
     attr_reader :traits
 
-    def initialize(record, locales) # :nodoc:
+    # @!visibility private
+    def initialize(record, locales)
       @continent = MaxMind::GeoIP2::Record::Continent.new(
         record['continent'],
         locales,

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'maxmind/geoip2/model/abstract'
+
+module MaxMind::GeoIP2::Model
+  # Model class for the GeoIP2 Domain database.
+  class Domain < Abstract
+    # The second level domain associated with the IP address. This will be
+    # something like "example.com" or "example.co.uk", not "foo.example.com".
+    #
+    # @return [String, nil]
+    def domain
+      get('domain')
+    end
+
+    # The IP address that the data in the model is for.
+    #
+    # @return [String]
+    def ip_address
+      get('ip_address')
+    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.
+    #
+    # @return [String]
+    def network
+      get('network')
+    end
+  end
+end