maxmind-geoip2 0.0.1 → 0.5.0

data/lib/maxmind/geoip2/errors.rb

@@ -1,7 +1,41 @@
 # frozen_string_literal: true
 
-module MaxMind::GeoIP2
-  # An AddressNotFoundError means the IP address was not found in the database.
-  class AddressNotFoundError < RuntimeError
+module MaxMind
+  module GeoIP2
+    # 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
+    end
+
+    # An HTTPError means there was an unexpected HTTP status or response.
+    class HTTPError < RuntimeError
+    end
+
+    # An AddressInvalidError means the IP address was invalid.
+    class AddressInvalidError < RuntimeError
+    end
+
+    # An AddressReservedError means the IP address is reserved.
+    class AddressReservedError < RuntimeError
+    end
+
+    # An AuthenticationError means there was a problem authenticating to the
+    # web service.
+    class AuthenticationError < RuntimeError
+    end
+
+    # An InsufficientFundsError means the account is out of credits.
+    class InsufficientFundsError < RuntimeError
+    end
+
+    # A PermissionRequiredError means the account does not have permission to
+    # use the requested service.
+    class PermissionRequiredError < RuntimeError
+    end
+
+    # An InvalidRequestError means the web service returned an error and there
+    # is no more specific error class.
+    class InvalidRequestError < RuntimeError
+    end
   end
 end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'ipaddr'
+
+module MaxMind
+  module GeoIP2
+    module 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
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'maxmind/geoip2/model/abstract'
+
+module MaxMind
+  module GeoIP2
+    module 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
+        # hosting_provider? method.
+        #
+        # @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 anonymous_vpn? method).
+        #
+        # @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 on a suspected anonymizing network
+        # and belongs to a residential ISP.
+        #
+        # @return [Boolean]
+        def residential_proxy?
+          get('is_residential_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
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'maxmind/geoip2/model/abstract'
+
+module MaxMind
+  module GeoIP2
+    module 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
+  end
+end

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

@@ -6,54 +6,73 @@ require 'maxmind/geoip2/record/location'
 require 'maxmind/geoip2/record/postal'
 require 'maxmind/geoip2/record/subdivision'
 
-module MaxMind::GeoIP2::Model
-  # Model class for the data returned by the GeoIP2 City web service and
-  # 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/geoip2/web-services for more details.
-  #
-  # See Country for inherited methods.
-  class City < Country
-    # City data for the IP address. See MaxMind::GeoIP2::Record::City.
-    attr_reader :city
-
-    # Location data for the IP address. See MaxMind::GeoIP2::Record::Location.
-    attr_reader :location
-
-    # Postal data for the IP address. See 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.
-    attr_reader :subdivisions
-
-    def initialize(record, locales) # :nodoc:
-      super(record, locales)
-      @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'])
-      @subdivisions = create_subdivisions(record['subdivisions'], locales)
-    end
+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.
+      #
+      # 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.
+      #
+      # See {MaxMind::GeoIP2::Model::Country} for inherited methods.
+      class City < Country
+        # City data for the IP address.
+        #
+        # @return [MaxMind::GeoIP2::Record::City]
+        attr_reader :city
 
-    # Return an object representing the most specific subdivision returned. If
-    # the response did not contain any subdivisions, this method returns nil.
-    def most_specific_subdivision
-      @subdivisions.last
-    end
+        # Location data for the IP address.
+        #
+        # @return [MaxMind::GeoIP2::Record::Location]
+        attr_reader :location
+
+        # Postal data for the IP address.
+        #
+        # @return [MaxMind::GeoIP2::Record::Postal]
+        attr_reader :postal
+
+        # 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
+
+        # @!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'])
+          @postal = MaxMind::GeoIP2::Record::Postal.new(record['postal'])
+          @subdivisions = create_subdivisions(record['subdivisions'], locales)
+        end
+
+        # 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
 
-    private
+        private
 
-    def create_subdivisions(subdivisions, locales)
-      return [] if subdivisions.nil?
+        def create_subdivisions(subdivisions, locales)
+          return [] if subdivisions.nil?
 
-      subdivisions.map do |s|
-        MaxMind::GeoIP2::Record::Subdivision.new(s, locales)
+          subdivisions.map do |s|
+            MaxMind::GeoIP2::Record::Subdivision.new(s, locales)
+          end
+        end
       end
     end
   end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'maxmind/geoip2/model/abstract'
+
+module MaxMind
+  module GeoIP2
+    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.
+        #
+        # @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
+  end
+end

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

@@ -2,54 +2,73 @@
 
 require 'maxmind/geoip2/record/continent'
 require 'maxmind/geoip2/record/country'
+require 'maxmind/geoip2/record/maxmind'
 require 'maxmind/geoip2/record/represented_country'
 require 'maxmind/geoip2/record/traits'
 
-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.
-    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.
-    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.
-    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.
-    attr_reader :represented_country
-
-    # Data for the traits of the IP address. See
-    # MaxMind::GeoIP2::Record::Traits.
-    attr_reader :traits
-
-    def initialize(record, locales) # :nodoc:
-      @continent = MaxMind::GeoIP2::Record::Continent.new(
-        record['continent'],
-        locales,
-      )
-      @country = MaxMind::GeoIP2::Record::Country.new(
-        record['country'],
-        locales,
-      )
-      @registered_country = MaxMind::GeoIP2::Record::Country.new(
-        record['registered_country'],
-        locales,
-      )
-      @represented_country = MaxMind::GeoIP2::Record::RepresentedCountry.new(
-        record['represented_country'],
-        locales,
-      )
-      @traits = MaxMind::GeoIP2::Record::Traits.new(record['traits'])
+module MaxMind
+  module GeoIP2
+    module 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.
+        #
+        # @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.
+        #
+        # @return [MaxMind::GeoIP2::Record::Country]
+        attr_reader :country
+
+        # Data related to your MaxMind account.
+        #
+        # @return [MaxMind::GeoIP2::Record::MaxMind]
+        attr_reader :maxmind
+
+        # 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.
+        #
+        # @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.
+        #
+        # @return [MaxMind::GeoIP2::Record::RepresentedCountry]
+        attr_reader :represented_country
+
+        # Data for the traits of the IP address.
+        #
+        # @return [MaxMind::GeoIP2::Record::Traits]
+        attr_reader :traits
+
+        # @!visibility private
+        def initialize(record, locales)
+          @continent = MaxMind::GeoIP2::Record::Continent.new(
+            record['continent'],
+            locales,
+          )
+          @country = MaxMind::GeoIP2::Record::Country.new(
+            record['country'],
+            locales,
+          )
+          @maxmind = MaxMind::GeoIP2::Record::MaxMind.new(record['maxmind'])
+          @registered_country = MaxMind::GeoIP2::Record::Country.new(
+            record['registered_country'],
+            locales,
+          )
+          @represented_country = MaxMind::GeoIP2::Record::RepresentedCountry.new(
+            record['represented_country'],
+            locales,
+          )
+          @traits = MaxMind::GeoIP2::Record::Traits.new(record['traits'])
+        end
+      end
     end
   end
 end