minfraud 1.0.0 → 1.1.0

data/lib/minfraud/model/device.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'minfraud/model/abstract'
+
+module Minfraud
+  module Model
+    # Model with information about the device.
+    #
+    # In order to receive device output from minFraud Insights or minFraud
+    # Factors, you must be using the Device Tracking Add-on
+    # (https://dev.maxmind.com/minfraud/device/).
+    class Device < Abstract
+      # This number represents our confidence that the device_id refers to a
+      # unique device as opposed to a cluster of similar devices. A confidence
+      # of 0.01 indicates very low confidence that the device is unique,
+      # whereas 99 indicates very high confidence.
+      #
+      # @return [Float, nil]
+      attr_reader :confidence
+
+      # A UUID that MaxMind uses for the device associated with this IP
+      # address. Note that many devices cannot be uniquely identified because
+      # they are too common (for example, all iPhones of a given model and OS
+      # release). In these cases, the minFraud service will simply not return a
+      # UUID for that device.
+      #
+      # @return [String, nil]
+      attr_reader :id
+
+      # This is the date and time of the last sighting of the device. This is
+      # an RFC 3339 date-time.
+      #
+      # @return [String, nil]
+      attr_reader :last_seen
+
+      # This is the local date and time of the transaction in the time zone of
+      # the device. This is determined by using the UTC offset associated with
+      # the device. This is an RFC 3339 date-time
+      #
+      # @return [String, nil]
+      attr_reader :local_time
+
+      # @!visibility private
+      def initialize(record)
+        super(record)
+
+        @confidence = get('confidence')
+        @id = get('id')
+        @last_seen = get('last_seen')
+        @local_time = get('local_time')
+      end
+    end
+  end
+end

data/lib/minfraud/model/disposition.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'minfraud/model/abstract'
+
+module Minfraud
+  module Model
+    # Model with the disposition set by custom rules.
+    #
+    # In order to receive a disposition, you must be using minFraud custom
+    # rules.
+    class Disposition < Abstract
+      # The action to take on the transaction as defined by your custom rules.
+      # The current set of values are "accept", "manual_review", and "reject".
+      # If you do not have custom rules set up, this will be nil.
+      #
+      # @return [String, nil]
+      attr_reader :action
+
+      # The reason for the action. The current possible values are
+      # "custom_rule", "block_list", and "default". If you do not have custom
+      # rules set up, this will be nil.
+      #
+      # @return [String, nil]
+      attr_reader :reason
+
+      # @!visibility private
+      def initialize(record)
+        super(record)
+
+        @action = get('action')
+        @reason = get('reason')
+      end
+    end
+  end
+end

data/lib/minfraud/model/email.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'minfraud/model/abstract'
+require 'minfraud/model/email_domain'
+
+module Minfraud
+  module Model
+    # Model containing information about the email address.
+    class Email < Abstract
+      # An object containing information about the email domain.
+      #
+      # @return [Minfraud::Model::EmailDomain]
+      attr_reader :domain
+
+      # A date string (e.g. 2017-04-24) to identify the date an email address
+      # was first seen by MaxMind. This is expressed using the ISO 8601 date
+      # format.
+      #
+      # @return [String, nil]
+      attr_reader :first_seen
+
+      # Whether this email address is from a disposable email provider. The
+      # value will be nil when no email address or email domain has been passed
+      # as an input.
+      #
+      # @return [Boolean, nil]
+      attr_reader :is_disposable
+
+      # This property is true if MaxMind believes that this email is hosted by
+      # a free email provider such as Gmail or Yahoo! Mail.
+      #
+      # @return [Boolean, nil]
+      attr_reader :is_free
+
+      # This field is true if MaxMind believes that this email is likely to be
+      # used for fraud. Note that this is also factored into the overall
+      # risk_score in the response as well.
+      #
+      # @return [Boolean, nil]
+      attr_reader :is_high_risk
+
+      # @!visibility private
+      def initialize(record)
+        super(record)
+
+        @domain = Minfraud::Model::EmailDomain.new(get('domain'))
+        @first_seen = get('first_seen')
+        @is_disposable = get('is_disposable')
+        @is_free = get('is_free')
+        @is_high_risk = get('is_high_risk')
+      end
+    end
+  end
+end

data/lib/minfraud/model/email_domain.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'minfraud/model/abstract'
+
+module Minfraud
+  module Model
+    # Model containing information about the email domain.
+    class EmailDomain < Abstract
+      # A date string (e.g. 2017-04-24) to identify the date an email domain
+      # was first seen by MaxMind. This is expressed using the ISO 8601 date
+      # format.
+      #
+      # @return [String, nil]
+      attr_reader :first_seen
+
+      # @!visibility private
+      def initialize(record)
+        super(record)
+
+        @first_seen = get('first_seen')
+      end
+    end
+  end
+end

data/lib/minfraud/model/error.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'minfraud/model/abstract'
+
+module Minfraud
+  module Model
+    # Model with information about an error.
+    class Error < Abstract
+      # An error code for machine use.
+      #
+      # @return [String]
+      attr_reader :code
+
+      # A human readable error message.
+      #
+      # @return [String]
+      attr_reader :error
+
+      # @!visibility private
+      def initialize(record)
+        super(record)
+
+        @code = get('code')
+        @error = get('error')
+      end
+    end
+  end
+end

data/lib/minfraud/model/factors.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'minfraud/model/insights'
+require 'minfraud/model/subscores'
+
+module Minfraud
+  module Model
+    # Model representing the Factors response.
+    class Factors < Insights
+      # An object containing subscores for many of the individual components
+      # that are used to calculate the overall risk score.
+      #
+      # @return [Minfraud::Model::Subscores]
+      attr_reader :subscores
+
+      # @!visibility private
+      def initialize(record, locales)
+        super(record, locales)
+
+        @subscores = Minfraud::Model::Subscores.new(get('subscores'))
+      end
+    end
+  end
+end

data/lib/minfraud/model/geoip2_location.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'maxmind/geoip2/record/location'
+
+module Minfraud
+  module Model
+    # Model of the GeoIP2 location information, including the local time.
+    class GeoIP2Location < MaxMind::GeoIP2::Record::Location
+      # The date and time of the transaction in the time zone associated with
+      # the IP address. The value is formatted according to RFC 3339. For
+      # instance, the local time in Boston might be returned as
+      # 2015-04-27T19:17:24-04:00.
+      #
+      # @return [String]
+      attr_reader :local_time
+
+      # @!visibility private
+      def initialize(record)
+        super(record)
+
+        @local_time = get('local_time')
+      end
+    end
+  end
+end

data/lib/minfraud/model/insights.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'minfraud/model/billing_address'
+require 'minfraud/model/credit_card'
+require 'minfraud/model/device'
+require 'minfraud/model/email'
+require 'minfraud/model/ip_address'
+require 'minfraud/model/score'
+require 'minfraud/model/shipping_address'
+
+module Minfraud
+  module Model
+    # Model of the Insights response.
+    class Insights < Score
+      # An object containing minFraud data related to the billing address used
+      # in the transaction.
+      #
+      # @return [Minfraud::Model::BillingAddress]
+      attr_reader :billing_address
+
+      # An object containing minFraud data about the credit card used in the
+      # transaction.
+      #
+      # @return [Minfraud::Model::CreditCard]
+      attr_reader :credit_card
+
+      # This object contains information about the device that MaxMind believes
+      # is associated with the IP address passed in the request.
+      #
+      # @return [Minfraud::Model::Device]
+      attr_reader :device
+
+      # This object contains information about the email address passed in the
+      # request.
+      #
+      # @return [Minfraud::Model::Email]
+      attr_reader :email
+
+      # An object containing GeoIP2 and minFraud Insights information about the
+      # geolocated IP address.
+      #
+      # @return [Minfraud::Model::IPAddress]
+      attr_reader :ip_address
+
+      # An object containing minFraud data related to the shipping address used
+      # in the transaction.
+      #
+      # @return [Minfraud::Model::ShippingAddress]
+      attr_reader :shipping_address
+
+      # @!visibility private
+      def initialize(record, locales)
+        super(record, locales)
+
+        @billing_address = Minfraud::Model::BillingAddress.new(
+          get('billing_address')
+        )
+        @credit_card = Minfraud::Model::CreditCard.new(get('credit_card'))
+        @device = Minfraud::Model::Device.new(get('device'))
+        @email = Minfraud::Model::Email.new(get('email'))
+        @ip_address = Minfraud::Model::IPAddress.new(get('ip_address'), locales)
+        @shipping_address = Minfraud::Model::ShippingAddress.new(
+          get('shipping_address')
+        )
+      end
+    end
+  end
+end

data/lib/minfraud/model/ip_address.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'maxmind/geoip2/model/insights'
+require 'minfraud/model/geoip2_location'
+
+module Minfraud
+  module Model
+    # Model containing GeoIP2 data and the risk for the IP address.
+    class IPAddress < MaxMind::GeoIP2::Model::Insights
+      # This field contains the risk associated with the IP address. The value
+      # ranges from 0.01 to 99. A higher score indicates a higher risk.
+      #
+      # @return [Float]
+      attr_reader :risk
+
+      # @!visibility private
+      def initialize(record, locales)
+        super(record, locales)
+
+        if record
+          @location = Minfraud::Model::GeoIP2Location.new(record.fetch('location', nil))
+        else
+          @location = Minfraud::Model::GeoIP2Location.new(nil)
+        end
+        if record
+          @risk = record.fetch('risk', nil)
+        else
+          @risk = nil
+        end
+
+        # Decorate objects with deprecated attributes and names for backwards
+        # compatibility. Do this here rather than with the overhead of
+        # subclasses/modules for them in the hope that one day we can delete
+        # them.
+
+        # These are named differently in maxmind-geoip2.
+        @country.define_singleton_method(:is_in_european_union) { in_european_union? }
+        @registered_country.define_singleton_method(:is_in_european_union) { in_european_union? }
+        @represented_country.define_singleton_method(:is_in_european_union) { in_european_union? }
+        @traits.define_singleton_method(:is_anonymous) { anonymous? }
+        @traits.define_singleton_method(:is_anonymous_vpn) { anonymous_vpn? }
+        @traits.define_singleton_method(:is_hosting_provider) { hosting_provider? }
+        @traits.define_singleton_method(:is_public_proxy) { public_proxy? }
+        @traits.define_singleton_method(:is_tor_exit_node) { tor_exit_node? }
+
+        # Mashify turned each language code into an attribute, but
+        # maxmind-geoip2 exposes the names as a hash.
+        LANGUAGE_CODES.each do |c|
+          if @city.names
+            @city.names.define_singleton_method(c) { fetch(c.to_s, nil) }
+          end
+          if @continent.names
+            @continent.names.define_singleton_method(c) { fetch(c.to_s, nil) }
+          end
+          if @country.names
+            @country.names.define_singleton_method(c) { fetch(c.to_s, nil) }
+          end
+          if @registered_country.names
+            @registered_country.names.define_singleton_method(c) { fetch(c.to_s, nil) }
+          end
+          if @represented_country.names
+            @represented_country.names.define_singleton_method(c) { fetch(c.to_s, nil) }
+          end
+          @subdivisions.each do |s|
+            if s.names
+              s.names.define_singleton_method(c) { fetch(c.to_s, nil) }
+            end
+          end
+        end
+
+        # This attribute is deprecated.
+        @country.define_singleton_method(:is_high_risk) { get('is_high_risk') }
+
+        # These attributes are deprecated and aren't in maxmind-geoip2.
+        @traits.define_singleton_method(:is_anonymous_proxy) { get('is_anonymous_proxy') }
+        @traits.define_singleton_method(:is_satellite_provider) { get('is_satellite_provider') }
+      end
+
+      LANGUAGE_CODES = [:de, :en, :es, :fr, :ja, :'pt-BR', :ru, :'zh-CN'].freeze
+    end
+  end
+end

data/lib/minfraud/model/issuer.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'minfraud/model/abstract'
+
+module Minfraud
+  module Model
+    # Model containing information about the card issuer.
+    class Issuer < Abstract
+      # The name of the bank which issued the credit card.
+      #
+      # @return [String, nil]
+      attr_reader :name
+
+      # This property is true if the name matches the name provided in the
+      # request for the card issuer. It is false if the name does not match.
+      # The property is nil if either no name or issuer ID number (IIN) was
+      # provided in the request or if MaxMind does not have a name associated
+      # with the IIN.
+      #
+      # @return [Boolean, nil]
+      attr_reader :matches_provided_name
+
+      # This property is true if the phone number matches the number provided
+      # in the request for the card issuer. It is false if the number does not
+      # match. It is nil if either no phone number was provided or issuer ID
+      # number (IIN) was provided in the request or if MaxMind does not have a
+      # phone number associated with the IIN.
+      #
+      # @return [Boolean, nil]
+      attr_reader :matches_provided_phone_number
+
+      # The phone number of the bank which issued the credit card. In some
+      # cases the phone number we return may be out of date.
+      #
+      # @return [String, nil]
+      attr_reader :phone_number
+
+      # @!visibility private
+      def initialize(record)
+        super(record)
+
+        @name = get('name')
+        @phone_number = get('phone_number')
+        @matches_provided_name = get('matches_provided_name')
+        @matches_provided_phone_number = get('matches_provided_phone_number')
+      end
+    end
+  end
+end