minfraud 1.0.0 → 1.1.0

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

@@ -0,0 +1,94 @@
+# Copyright (c) 2020 by MaxMind, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# frozen_string_literal: true
+
+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
+  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

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

@@ -0,0 +1,38 @@
+# Copyright (c) 2020 by MaxMind, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# frozen_string_literal: true
+
+require 'maxmind/geoip2/model/city'
+
+module MaxMind
+  module GeoIP2
+    module Model
+      # Model class for the data returned by the GeoIP2 Precision Insights web
+      # service.
+      #
+      # 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.
+      class Insights < City
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# Copyright (c) 2020 by MaxMind, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# frozen_string_literal: true
+
+module MaxMind
+  module GeoIP2
+    module Record
+      # @!visibility private
+      class Abstract
+        def initialize(record)
+          @record = record
+        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/record/city.rb

@@ -0,0 +1,62 @@
+# Copyright (c) 2020 by MaxMind, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# frozen_string_literal: true
+
+require 'maxmind/geoip2/record/place'
+
+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.
+        #
+        # @return [Integer, nil]
+        def geoname_id
+          get('geoname_id')
+        end
+
+        # 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

@@ -0,0 +1,61 @@
+# Copyright (c) 2020 by MaxMind, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# frozen_string_literal: true
+
+require 'maxmind/geoip2/record/place'
+
+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.
+        #
+        # @return [String, nil]
+        def geoname_id
+          get('geoname_id')
+        end
+
+        # 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

@@ -0,0 +1,78 @@
+# Copyright (c) 2020 by MaxMind, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# frozen_string_literal: true
+
+require 'maxmind/geoip2/record/place'
+
+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.
+        #
+        # @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.
+        #
+        # @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.
+        #
+        # @return [String, nil]
+        def iso_code
+          get('iso_code')
+        end
+
+        # 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

@@ -0,0 +1,97 @@
+# Copyright (c) 2020 by MaxMind, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# frozen_string_literal: true
+
+require 'maxmind/geoip2/record/abstract'
+
+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.
+        #
+        # @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.
+        #
+        # @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.
+        #
+        # @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.
+        #
+        # @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.
+        #
+        # @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.
+        #
+        # @return [String, nil]
+        def time_zone
+          get('time_zone')
+        end
+      end
+    end
+  end
+end