maxmind-geoip2 0.0.1 → 0.5.0

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

@@ -1,21 +1,26 @@
 # frozen_string_literal: true
 
-module MaxMind::GeoIP2::Record
-  class Abstract # :nodoc:
-    def initialize(record)
-      @record = record
-    end
+module MaxMind
+  module GeoIP2
+    module Record
+      # @!visibility private
+      class Abstract
+        def initialize(record)
+          @record = record
+        end
 
-    protected
+        protected
 
-    def get(key)
-      if @record.nil? || !@record.key?(key)
-        return false if key.start_with?('is_')
+        def get(key)
+          if @record.nil? || !@record.key?(key)
+            return false if key.start_with?('is_')
 
-        return nil
-      end
+            return nil
+          end
 
-      @record[key]
+          @record[key]
+        end
+      end
     end
   end
 end

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

@@ -2,32 +2,41 @@
 
 require 'maxmind/geoip2/record/place'
 
-module MaxMind::GeoIP2::Record
-  # City-level data associated with an IP address.
-  #
-  # This record is returned by all location services and databases besides
-  # Country.
-  #
-  # See Place for inherited methods.
-  class City < Place
-    # A value from 0-100 indicating MaxMind's confidence that the city 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
+      # City-level data associated with an IP address.
+      #
+      # This record is returned by all location services and databases besides
+      # Country.
+      #
+      # See {MaxMind::GeoIP2::Record::Place} for inherited methods.
+      class City < Place
+        # A value from 0-100 indicating MaxMind's confidence that the city is
+        # correct. This attribute is only available from the Insights service and
+        # the GeoIP2 Enterprise database.
+        #
+        # @return [Integer, nil]
+        def confidence
+          get('confidence')
+        end
 
-    # The GeoName ID for the city. This attribute is returned by all location
-    # services and databases. Integer but may be nil.
-    def geoname_id
-      get('geoname_id')
-    end
+        # The GeoName ID for the city. This attribute is returned by all location
+        # services and databases.
+        #
+        # @return [Integer, nil]
+        def geoname_id
+          get('geoname_id')
+        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. 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.
+        #
+        # @return [Hash<String, String>, nil]
+        def names
+          get('names')
+        end
+      end
     end
   end
 end

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

@@ -2,31 +2,40 @@
 
 require 'maxmind/geoip2/record/place'
 
-module MaxMind::GeoIP2::Record
-  # Contains data for the continent record associated with an IP address.
-  #
-  # This record is returned by all location services and databases.
-  #
-  # See Place for inherited methods.
-  class Continent < Place
-    # A two character continent code like "NA" (North America) or "OC"
-    # (Oceania). This attribute is returned by all location services and
-    # databases. String but may be nil.
-    def code
-      get('code')
-    end
+module MaxMind
+  module GeoIP2
+    module Record
+      # Contains data for the continent record associated with an IP address.
+      #
+      # This record is returned by all location services and databases.
+      #
+      # See {MaxMind::GeoIP2::Record::Place} for inherited methods.
+      class Continent < Place
+        # A two character continent code like "NA" (North America) or "OC"
+        # (Oceania). This attribute is returned by all location services and
+        # databases.
+        #
+        # @return [String, nil]
+        def code
+          get('code')
+        end
 
-    # The GeoName ID for the continent. This attribute is returned by all
-    # location services and databases. String but may be nil.
-    def geoname_id
-      get('geoname_id')
-    end
+        # The GeoName ID for the continent. This attribute is returned by all
+        # location services and databases.
+        #
+        # @return [String, nil]
+        def geoname_id
+          get('geoname_id')
+        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. 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.
+        #
+        # @return [Hash<String, String>, nil]
+        def names
+          get('names')
+        end
+      end
     end
   end
 end

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

@@ -2,44 +2,57 @@
 
 require 'maxmind/geoip2/record/place'
 
-module MaxMind::GeoIP2::Record
-  # Contains data for the country record associated with an IP address.
-  #
-  # This record is returned by all location services and databases.
-  #
-  # See Place for inherited methods.
-  class Country < Place
-    # A value from 0-100 indicating MaxMind's confidence that the country 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 country record associated with an IP address.
+      #
+      # This record is returned by all location services and databases.
+      #
+      # See {MaxMind::GeoIP2::Record::Place} for inherited methods.
+      class Country < Place
+        # A value from 0-100 indicating MaxMind's confidence that the country is
+        # correct. This attribute is only available from the Insights service and
+        # the GeoIP2 Enterprise database.
+        #
+        # @return [Integer, nil]
+        def confidence
+          get('confidence')
+        end
 
-    # The GeoName ID for the country. This attribute is returned by all
-    # location services and databases. Integer but may be nil.
-    def geoname_id
-      get('geoname_id')
-    end
+        # The GeoName ID for the country. This attribute is returned by all
+        # location services and databases.
+        #
+        # @return [Integer, nil]
+        def geoname_id
+          get('geoname_id')
+        end
 
-    # This is true if the country is a member state of the European Union. This
-    # attribute is returned by all location services and databases. Boolean.
-    def in_european_union?
-      get('is_in_european_union')
-    end
+        # This is true if the country is a member state of the European Union. This
+        # attribute is returned by all location services and databases.
+        #
+        # @return [Boolean]
+        def in_european_union?
+          get('is_in_european_union')
+        end
 
-    # The two-character ISO 3166-1 alpha code for the country. See
-    # https://en.wikipedia.org/wiki/ISO_3166-1. This attribute is returned by
-    # all location services and databases. String but may be nil.
-    def iso_code
-      get('iso_code')
-    end
+        # The two-character ISO 3166-1 alpha code for the country. See
+        # https://en.wikipedia.org/wiki/ISO_3166-1. This attribute is returned by
+        # all location services and databases.
+        #
+        # @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. 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.
+        #
+        # @return [Hash<String, String>, nil]
+        def names
+          get('names')
+        end
+      end
     end
   end
 end

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

@@ -2,62 +2,76 @@
 
 require 'maxmind/geoip2/record/abstract'
 
-module MaxMind::GeoIP2::Record
-  # Contains data for the location record associated with an IP address.
-  #
-  # This record is returned by all location services and databases besides
-  # Country.
-  class Location < Abstract
-    # The approximate accuracy radius in kilometers around the latitude and
-    # longitude for the IP address. This is the radius where we have a 67%
-    # confidence that the device using the IP address resides within the circle
-    # centered at the latitude and longitude with the provided radius. Integer
-    # but may be nil.
-    def accuracy_radius
-      get('accuracy_radius')
-    end
+module MaxMind
+  module GeoIP2
+    module Record
+      # Contains data for the location record associated with an IP address.
+      #
+      # This record is returned by all location services and databases besides
+      # Country.
+      class Location < Abstract
+        # The approximate accuracy radius in kilometers around the latitude and
+        # longitude for the IP address. This is the radius where we have a 67%
+        # confidence that the device using the IP address resides within the circle
+        # centered at the latitude and longitude with the provided radius.
+        #
+        # @return [Integer, nil]
+        def accuracy_radius
+          get('accuracy_radius')
+        end
 
-    # The average income in US dollars associated with the requested IP
-    # address. This attribute is only available from the Insights service.
-    # Integer but may be nil.
-    def average_income
-      get('average_income')
-    end
+        # The average income in US dollars associated with the requested IP
+        # address. This attribute is only available from the Insights service.
+        #
+        # @return [Integer, nil]
+        def average_income
+          get('average_income')
+        end
 
-    # The approximate latitude of the location associated with the IP address.
-    # This value is not precise and should not be used to identify a particular
-    # address or household. Float but may be nil.
-    def latitude
-      get('latitude')
-    end
+        # The approximate latitude of the location associated with the IP address.
+        # This value is not precise and should not be used to identify a particular
+        # address or household.
+        #
+        # @return [Float, nil]
+        def latitude
+          get('latitude')
+        end
 
-    # The approximate longitude of the location associated with the IP address.
-    # This value is not precise and should not be used to identify a particular
-    # address or household. Float but may be nil.
-    def longitude
-      get('longitude')
-    end
+        # The approximate longitude of the location associated with the IP address.
+        # This value is not precise and should not be used to identify a particular
+        # address or household.
+        #
+        # @return [Float, nil]
+        def longitude
+          get('longitude')
+        end
 
-    # The metro code of the location if the location is in the US. MaxMind
-    # returns the same metro codes as the Google AdWords API. See
-    # https://developers.google.com/adwords/api/docs/appendix/cities-DMAregions.
-    # Integer but may be nil.
-    def metro_code
-      get('metro_code')
-    end
+        # The metro code of the location if the location is in the US. MaxMind
+        # returns the same metro codes as the Google AdWords API. See
+        # https://developers.google.com/adwords/api/docs/appendix/cities-DMAregions.
+        #
+        # @return [Integer, nil]
+        def metro_code
+          get('metro_code')
+        end
 
-    # The estimated population per square kilometer associated with the IP
-    # address. This attribute is only available from the Insights service.
-    # Integer but may be nil.
-    def population_density
-      get('population_density')
-    end
+        # The estimated population per square kilometer associated with the IP
+        # address. This attribute is only available from the Insights service.
+        #
+        # @return [Integer, nil]
+        def population_density
+          get('population_density')
+        end
 
-    # The time zone associated with location, as specified by the IANA Time
-    # Zone Database, e.g., "America/New_York". See
-    # https://www.iana.org/time-zones. String but may be nil.
-    def time_zone
-      get('time_zone')
+        # The time zone associated with location, as specified by the IANA Time
+        # Zone Database, e.g., "America/New_York". See
+        # https://www.iana.org/time-zones.
+        #
+        # @return [String, nil]
+        def time_zone
+          get('time_zone')
+        end
+      end
     end
   end
 end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'maxmind/geoip2/record/abstract'
+
+module MaxMind
+  module GeoIP2
+    module Record
+      # Contains data about your account.
+      #
+      # This record is returned by all location services.
+      class MaxMind < Abstract
+        # The number of remaining queries you have for the service you are calling.
+        #
+        # @return [Integer, nil]
+        def queries_remaining
+          get('queries_remaining')
+        end
+      end
+    end
+  end
+end

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

@@ -2,25 +2,31 @@
 
 require 'maxmind/geoip2/record/abstract'
 
-module MaxMind::GeoIP2::Record
-  # Location data common to different location types.
-  class Place < Abstract
-    def initialize(record, locales) # :nodoc:
-      super(record)
-      @locales = locales
-    end
+module MaxMind
+  module GeoIP2
+    module Record
+      # Location data common to different location types.
+      class Place < Abstract
+        # @!visibility private
+        def initialize(record, locales)
+          super(record)
+          @locales = locales
+        end
 
-    # A string containing the first available localized name in order of
-    # preference.
-    def name
-      n = names
-      return nil if n.nil?
+        # The first available localized name in order of preference.
+        #
+        # @return [String, nil]
+        def name
+          n = names
+          return nil if n.nil?
 
-      @locales.each do |locale|
-        return n[locale] if n.key?(locale)
-      end
+          @locales.each do |locale|
+            return n[locale] if n.key?(locale)
+          end
 
-      nil
+          nil
+        end
+      end
     end
   end
 end