maxmind-geoip2 0.0.1 → 0.5.0

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

@@ -2,25 +2,33 @@
 
 require 'maxmind/geoip2/record/abstract'
 
-module MaxMind::GeoIP2::Record
-  # Contains data for the postal record associated with an IP address.
-  #
-  # This record is returned by all location services and databases besides
-  # Country.
-  class Postal < Abstract
-    # The postal code of the location. Postal codes are not available for all
-    # countries. In some countries, this will only contain part of the postal
-    # code. This attribute is returned by all location databases and services
-    # besides Country. String but may be nil.
-    def code
-      get('code')
-    end
+module MaxMind
+  module GeoIP2
+    module Record
+      # Contains data for the postal record associated with an IP address.
+      #
+      # This record is returned by all location services and databases besides
+      # Country.
+      class Postal < Abstract
+        # The postal code of the location. Postal codes are not available for all
+        # countries. In some countries, this will only contain part of the postal
+        # code. This attribute is returned by all location databases and services
+        # besides Country.
+        #
+        # @return [String, nil]
+        def code
+          get('code')
+        end
 
-    # A value from 0-100 indicating MaxMind's confidence that the postal code
-    # is correct. This attribute is only available from the Insights service
-    # and the GeoIP2 Enterprise database. Integer but may be nil.
-    def confidence
-      get('confidence')
+        # A value from 0-100 indicating MaxMind's confidence that the postal code
+        # is correct. This attribute is only available from the Insights service
+        # and the GeoIP2 Enterprise database.
+        #
+        # @return [Integer, nil]
+        def confidence
+          get('confidence')
+        end
+      end
     end
   end
 end

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

@@ -2,20 +2,26 @@
 
 require 'maxmind/geoip2/record/country'
 
-module MaxMind::GeoIP2::Record
-  # Contains data for the represented country associated with an IP address.
-  #
-  # This class contains the country-level data associated with an IP address
-  # for the IP's represented country. The represented country is the country
-  # represented by something like a military base.
-  #
-  # See Country for inherited methods.
-  class RepresentedCountry < Country
-    # A string indicating the type of entity that is representing the country.
-    # Currently we only return +military+ but this could expand to include
-    # other types in the future. String but may be nil.
-    def type
-      get('type')
+module MaxMind
+  module GeoIP2
+    module Record
+      # Contains data for the represented country associated with an IP address.
+      #
+      # This class contains the country-level data associated with an IP address
+      # for the IP's represented country. The represented country is the country
+      # represented by something like a military base.
+      #
+      # See {MaxMind::GeoIP2::Record::Country} for inherited methods.
+      class RepresentedCountry < Country
+        # A string indicating the type of entity that is representing the country.
+        # Currently we only return +military+ but this could expand to include
+        # other types in the future.
+        #
+        # @return [String, nil]
+        def type
+          get('type')
+        end
+      end
     end
   end
 end

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

@@ -2,43 +2,51 @@
 
 require 'maxmind/geoip2/record/place'
 
-module MaxMind::GeoIP2::Record
-  # Contains data for the subdivisions associated with an IP address.
-  #
-  # This record is returned by all location databases and services besides
-  # Country.
-  #
-  # See Place for inherited methods.
-  class Subdivision < Place
-    # This is a value from 0-100 indicating MaxMind's confidence that the
-    # subdivision is correct. This attribute is only available from the
-    # Insights service and the GeoIP2 Enterprise database. Integer but may be
-    # nil.
-    def confidence
-      get('confidence')
-    end
+module MaxMind
+  module GeoIP2
+    module Record
+      # Contains data for the subdivisions associated with an IP address.
+      #
+      # This record is returned by all location databases and services besides
+      # Country.
+      #
+      # See {MaxMind::GeoIP2::Record::Place} for inherited methods.
+      class Subdivision < Place
+        # This is a value from 0-100 indicating MaxMind's confidence that the
+        # subdivision is correct. This attribute is only available from the
+        # Insights service and the GeoIP2 Enterprise database.
+        #
+        # @return [Integer, nil]
+        def confidence
+          get('confidence')
+        end
 
-    # This is a GeoName ID for the subdivision. This attribute is returned by
-    # all location databases and services besides Country. Integer but may be
-    # nil.
-    def geoname_id
-      get('geoname_id')
-    end
+        # This is a GeoName ID for the subdivision. This attribute is returned by
+        # all location databases and services besides Country.
+        #
+        # @return [Integer, nil]
+        def geoname_id
+          get('geoname_id')
+        end
 
-    # This is a string up to three characters long contain the subdivision
-    # portion of the ISO 3166-2 code. See
-    # https://en.wikipedia.org/wiki/ISO_3166-2. This attribute is returned by
-    # all location databases and services except Country. String but may be
-    # nil.
-    def iso_code
-      get('iso_code')
-    end
+        # This is a string up to three characters long contain the subdivision
+        # portion of the ISO 3166-2 code. See
+        # https://en.wikipedia.org/wiki/ISO_3166-2. This attribute is returned by
+        # all location databases and services except Country.
+        #
+        # @return [String, nil]
+        def iso_code
+          get('iso_code')
+        end
 
-    # A Hash where the keys are locale codes (Strings) and the values are names
-    # (Strings). This attribute is returned by all location services and
-    # databases besides country. Hash but may be nil.
-    def names
-      get('names')
+        # A Hash where the keys are locale codes and the values are names. This attribute is returned by all location services and
+        # databases besides country.
+        #
+        # @return [Hash<String, String>, nil]
+        def names
+          get('names')
+        end
+      end
     end
   end
 end

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

@@ -3,167 +3,211 @@
 require 'ipaddr'
 require 'maxmind/geoip2/record/abstract'
 
-module MaxMind::GeoIP2::Record
-  # Contains data for the traits record associated with an IP address.
-  #
-  # This record is returned by all location services and databases.
-  class Traits < Abstract
-    def initialize(record) # :nodoc:
-      super(record)
-      if !record.key?('network') && record.key?('ip_address') &&
-         record.key?('prefix_length')
-        ip = IPAddr.new(
-          format('%s/%d', record['ip_address'], 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'])
+module MaxMind
+  module GeoIP2
+    module Record
+      # Contains data for the traits record associated with an IP address.
+      #
+      # This record is returned by all location services and databases.
+      class Traits < Abstract
+        # @!visibility private
+        def initialize(record)
+          super(record)
+          if !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'])
+          end
+        end
+
+        # The autonomous system number associated with the IP address. See
+        # Wikipedia[https://en.wikipedia.org/wiki/Autonomous_system_(Internet)].
+        # This attribute is only available from the City and Insights web service
+        # and the GeoIP2 Enterprise database.
+        #
+        # @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. See
+        # Wikipedia[https://en.wikipedia.org/wiki/Autonomous_system_(Internet)].
+        # This attribute is only available from the City and Insights web service
+        # and the GeoIP2 Enterprise database.
+        #
+        # @return [String, nil]
+        def autonomous_system_organization
+          get('autonomous_system_organization')
+        end
+
+        # The connection type may take the following  values: "Dialup",
+        # "Cable/DSL", "Corporate", "Cellular". Additional values may be added in
+        # the future. This attribute is only available in the GeoIP2 Enterprise
+        # database.
+        #
+        # @return [String, nil]
+        def connection_type
+          get('connection_type')
+        end
+
+        # The second level domain associated with the IP address. This will be
+        # something like "example.com" or "example.co.uk", not "foo.example.com".
+        # This attribute is only available from the City and Insights web service
+        # and the GeoIP2 Enterprise database.
+        #
+        # @return [String, nil]
+        def domain
+          get('domain')
+        end
+
+        # The IP address that the data in the model is for. If you performed a "me"
+        # lookup against the web service, this will be the externally routable IP
+        # address for the system the code is running on. If the system is behind a
+        # NAT, this may differ from the IP address locally assigned to it. This
+        # attribute is returned by all end points.
+        #
+        # @return [String]
+        def ip_address
+          get('ip_address')
+        end
+
+        # This is true if the IP address belongs to any sort of anonymous network.
+        # This property is only available from GeoIP2 Precision Insights.
+        #
+        # @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? property. This property is only available from GeoIP2
+        # Precision Insights.
+        #
+        # @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? property). This property is only
+        # available from GeoIP2 Precision Insights.
+        #
+        # @return [Boolean]
+        def hosting_provider?
+          get('is_hosting_provider')
+        end
+
+        # This attribute is true if MaxMind believes this IP address to be a
+        # legitimate proxy, such as an internal VPN used by a corporation. This
+        # attribute is only available in the GeoIP2 Enterprise database.
+        #
+        # @return [Boolean]
+        def legitimate_proxy?
+          get('is_legitimate_proxy')
+        end
+
+        # This is true if the IP address belongs to a public proxy. This property
+        # is only available from GeoIP2 Precision Insights.
+        #
+        # @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. This property is only available
+        # from GeoIP2 Precision Insights.
+        #
+        # @return [Boolean]
+        def residential_proxy?
+          get('is_residential_proxy')
+        end
+
+        # This is true if the IP address is a Tor exit node. This property is only
+        # available from GeoIP2 Precision Insights.
+        #
+        # @return [Boolean]
+        def tor_exit_node?
+          get('is_tor_exit_node')
+        end
+
+        # The name of the ISP associated with the IP address. This attribute is
+        # only available from the City and Insights web services and the GeoIP2
+        # Enterprise database.
+        #
+        # @return [String, nil]
+        def isp
+          get('isp')
+        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
+
+        # The name of the organization associated with the IP address. This
+        # attribute is only available from the City and Insights web services and
+        # the GeoIP2 Enterprise database.
+        #
+        # @return [String, nil]
+        def organization
+          get('organization')
+        end
+
+        # An indicator of how static or dynamic an IP address is. This property is
+        # only available from GeoIP2 Precision Insights.
+        #
+        # @return [Float, nil]
+        def static_ip_score
+          get('static_ip_score')
+        end
+
+        # The estimated number of users sharing the IP/network during the past 24
+        # hours. For IPv4, the count is for the individual IP. For IPv6, the count
+        # is for the /64 network. This property is only available from GeoIP2
+        # Precision Insights.
+        #
+        # @return [Integer, nil]
+        def user_count
+          get('user_count')
+        end
+
+        # The user type associated with the IP address. This can be one of the
+        # following values:
+        #
+        # * business
+        # * cafe
+        # * cellular
+        # * college
+        # * content_delivery_network
+        # * dialup
+        # * government
+        # * hosting
+        # * library
+        # * military
+        # * residential
+        # * router
+        # * school
+        # * search_engine_spider
+        # * traveler
+        #
+        # This attribute is only available from the Insights web service and the
+        # GeoIP2 Enterprise database.
+        #
+        # @return [String, nil]
+        def user_type
+          get('user_type')
+        end
       end
     end
-
-    # The autonomous system number associated with the IP address. See
-    # Wikipedia[https://en.wikipedia.org/wiki/Autonomous_system_(Internet)].
-    # This attribute is only available from the City and Insights web service
-    # and the GeoIP2 Enterprise database. Integer but may be nil.
-    def autonomous_system_number
-      get('autonomous_system_number')
-    end
-
-    # The organization associated with the registered autonomous system number
-    # for the IP address. See
-    # Wikipedia[https://en.wikipedia.org/wiki/Autonomous_system_(Internet)].
-    # This attribute is only available from the City and Insights web service
-    # and the GeoIP2 Enterprise database. String but may be nil.
-    def autonomous_system_organization
-      get('autonomous_system_organization')
-    end
-
-    # The connection type may take the following  values: "Dialup",
-    # "Cable/DSL", "Corporate", "Cellular". Additional values may be added in
-    # the future. This attribute is only available in the GeoIP2 Enterprise
-    # database. String but may be nil.
-    def connection_type
-      get('connection_type')
-    end
-
-    # The second level domain associated with the IP address. This will be
-    # something like "example.com" or "example.co.uk", not "foo.example.com".
-    # This attribute is only available from the City and Insights web service
-    # and the GeoIP2 Enterprise database. String but may be nil.
-    def domain
-      get('domain')
-    end
-
-    # The IP address that the data in the model is for. If you performed a "me"
-    # lookup against the web service, this will be the externally routable IP
-    # address for the system the code is running on. If the system is behind a
-    # NAT, this may differ from the IP address locally assigned to it. This
-    # attribute is returned by all end points. String.
-    def ip_address
-      get('ip_address')
-    end
-
-    # This is true if the IP address belongs to any sort of anonymous network.
-    # This property is only available from GeoIP2 Precision Insights. 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? property. This property is only available from GeoIP2
-    # Precision Insights. 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? property). This property is only
-    # available from GeoIP2 Precision Insights. Boolean.
-    def hosting_provider?
-      get('is_hosting_provider')
-    end
-
-    # This attribute is true if MaxMind believes this IP address to be a
-    # legitimate proxy, such as an internal VPN used by a corporation. This
-    # attribute is only available in the GeoIP2 Enterprise database. Boolean.
-    def legitimate_proxy?
-      get('is_legitimate_proxy')
-    end
-
-    # This is true if the IP address belongs to a public proxy. This property
-    # is only available from GeoIP2 Precision Insights. Boolean.
-    def public_proxy?
-      get('is_public_proxy')
-    end
-
-    # This is true if the IP address is a Tor exit node. This property is only
-    # available from GeoIP2 Precision Insights. Boolean.
-    def tor_exit_node?
-      get('is_tor_exit_node')
-    end
-
-    # The name of the ISP associated with the IP address. This attribute is
-    # only available from the City and Insights web services and the GeoIP2
-    # Enterprise database. String but may be nil.
-    def isp
-      get('isp')
-    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. String.
-    def network
-      get('network')
-    end
-
-    # The name of the organization associated with the IP address. This
-    # attribute is only available from the City and Insights web services and
-    # the GeoIP2 Enterprise database. String but may be nil.
-    def organization
-      get('organization')
-    end
-
-    # An indicator of how static or dynamic an IP address is. This property is
-    # only available from GeoIP2 Precision Insights. Float but may be nil.
-    def static_ip_score
-      get('static_ip_score')
-    end
-
-    # The estimated number of users sharing the IP/network during the past 24
-    # hours. For IPv4, the count is for the individual IP. For IPv6, the count
-    # is for the /64 network. This property is only available from GeoIP2
-    # Precision Insights. Integer but may be nil.
-    def user_count
-      get('user_count')
-    end
-
-    # The user type associated with the IP address. This can be one of the
-    # following values:
-    #
-    # * business
-    # * cafe
-    # * cellular
-    # * college
-    # * content_delivery_network
-    # * dialup
-    # * government
-    # * hosting
-    # * library
-    # * military
-    # * residential
-    # * router
-    # * school
-    # * search_engine_spider
-    # * traveler
-    #
-    # This attribute is only available from the Insights web service and the
-    # GeoIP2 Enterprise database.
-    #
-    # May be nil.
-    def user_type
-      get('user_type')
-    end
   end
 end